Struct SerializableGuid

A Guid that can be serialized by Unity. The 128-bit Guid is stored as two 64-bit ulongs. See also the creation utility at UnityEditor.XR.ARSubsystems.SerializableGuidUtil.

Implements

IEquatable<SerializableGuid>

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace: UnityEngine.XR.ARSubsystems

Assembly: Unity.XR.ARSubsystems.dll

Syntax

[Serializable]
public struct SerializableGuid : IEquatable<SerializableGuid>

Constructors

SerializableGuid(Guid)

Constructs a SerializableGuid from a Guid.

Declaration

public SerializableGuid(Guid guid)

Parameters

Type	Name	Description
Guid	guid	The Guid used to create the SerializableGuid

SerializableGuid(ulong, ulong)

Constructs a SerializableGuid from two 64-bit ulongs.

Declaration

public SerializableGuid(ulong guidLow, ulong guidHigh)

Parameters

Type	Name	Description
ulong	guidLow	The low 8 bytes of the Guid.
ulong	guidHigh	The high 8 bytes of the Guid.

Properties

empty

Used to represent System.Guid.Empty (that is, a GUID whose values are all zeros).

Declaration

public static SerializableGuid empty { get; }

Property Value

Type	Description
SerializableGuid

guid

Reconstructs the Guid from the serialized data.

Declaration

public Guid guid { get; }

Property Value

Type	Description
Guid

Methods

Equals(object)

Tests for equality.

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
object	obj	The object to compare against.

Returns

Type	Description
bool	True if obj is of type SerializableGuid and Equals(SerializableGuid) also returns true; otherwise false.

Overrides

ValueType.Equals(object)

Equals(SerializableGuid)

Tests for equality.

Declaration

public bool Equals(SerializableGuid other)

Parameters

Type	Name	Description
SerializableGuid	other	The other SerializableGuid to compare against.

Returns

Type	Description
bool	True if every field in other is equal to this SerializableGuid, otherwise false.

GetHashCode()

Generates a hash suitable for use with containers like HashSet and Dictionary.

Declaration

public override int GetHashCode()

Returns

Type	Description
int	A hash code generated from this object's fields.

Overrides

ValueType.GetHashCode()

ToString()

Generates a string representation of the Guid. Same as guid.ToString(). See Microsoft's documentation for more details.

Declaration

public override string ToString()

Returns

Type	Description
string	A string representation of the Guid.

Overrides

ValueType.ToString()

ToString(string)

Generates a string representation of the Guid. Same as guid.ToString(format).

Declaration

public string ToString(string format)

Parameters

Type	Name	Description
string	format	A single format specifier that indicates how to format the value of the Guid. See Microsoft's documentation for more details.

Returns

Type	Description
string	A string representation of the Guid.

ToString(string, IFormatProvider)

Generates a string representation of the Guid. Same as guid.ToString(format, provider).

Declaration

public string ToString(string format, IFormatProvider provider)

Parameters

Type	Name	Description
string	format	A single format specifier that indicates how to format the value of the Guid. See Microsoft's documentation for more details.
IFormatProvider	provider	An object that supplies culture-specific formatting information.

Returns

Type	Description
string	A string representation of the Guid.

Operators

operator ==(SerializableGuid, SerializableGuid)

Tests for equality. Same as Equals(SerializableGuid).

Declaration

public static bool operator ==(SerializableGuid lhs, SerializableGuid rhs)

Parameters

Type	Name	Description
SerializableGuid	lhs	The left-hand side of the comparison.
SerializableGuid	rhs	The right-hand side of the comparison.

Returns

Type	Description
bool	True if lhs is equal to rhs, otherwise false.

implicit operator SerializableGuid(TrackableId)

Convert from TrackableId to SerializableGuid using the SerializableGuid(ulong, ulong) constructor.

Declaration

public static implicit operator SerializableGuid(TrackableId trackableId)

Parameters

Type	Name	Description
TrackableId	trackableId	The TrackableId to convert.

Returns

Type	Description
SerializableGuid	The SerializableGuid.

operator !=(SerializableGuid, SerializableGuid)

Tests for inequality. Same as !Equals(SerializableGuid).

Declaration

public static bool operator !=(SerializableGuid lhs, SerializableGuid rhs)

Parameters

Type	Name	Description
SerializableGuid	lhs	The left-hand side of the comparison.
SerializableGuid	rhs	The right-hand side of the comparison.

Returns

Type	Description
bool	True if lhs is not equal to rhs, otherwise false.

Implements

IEquatable<T>