Firestore API - Struct Blob (3.1.0)

public struct Blob : IEquatable<Blob>

Reference documentation and code samples for the Firestore API struct Blob.

An immutable sequence of bytes.

Implements

IEquatableBlob

Namespace

GoogleCloudFirestore

Assembly

Google.Cloud.Firestore.dll

Remarks

Although this is a struct, it's effectively just a wrapper around a Protobuf ByteString. default(Blob) acts as if it had been constructed with Empty.

Properties

ByteString

public ByteString ByteString { get; }

The underlying Protobuf ByteString.

Property Value
TypeDescription
ByteString

this[int]

public byte this[int index] { get; }

Returns the byte at index index.

Parameter
NameDescription
indexint

The index in the blob to return. Must be greater than or equal to 0, and less than Length.

Property Value
TypeDescription
byte

The byte at index index.

Length

public int Length { get; }

The length of the blob, in bytes.

Property Value
TypeDescription
int

Methods

CopyFrom(byte[])

public static Blob CopyFrom(byte[] bytes)

Constructs a new Blob by copying the current content of bytes.

Parameter
NameDescription
bytesbyte

Byte array to copy.

Returns
TypeDescription
Blob

A new blob containing a copy of bytes.

FromByteString(ByteString)

public static Blob FromByteString(ByteString byteString)

Constructs a new Blob wrapping the given ByteString.

Parameter
NameDescription
byteStringByteString

The ByteString to wrap. Must not be null.

Returns
TypeDescription
Blob

A new blob wrapping byteString.

GetHashCode()

public override int GetHashCode()
Returns
TypeDescription
int
Overrides

ToString()

public override string ToString()
Returns
TypeDescription
string
Overrides

Operators

operator ==(Blob, Blob)

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

Operator overload to compare two Blob values for equality.

Parameters
NameDescription
lhsBlob

Left value to compare

rhsBlob

Right value to compare

Returns
TypeDescription
bool

true if lhs is equal to rhs; otherwise false.

operator !=(Blob, Blob)

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

Operator overload to compare two Blob values for inequality.

Parameters
NameDescription
lhsBlob

Left value to compare

rhsBlob

Right value to compare

Returns
TypeDescription
bool

false if lhs is equal to rhs; otherwise true.