Firestore API - Struct Blob (3.7.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

Google.Cloud.Firestore

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
Type Description
ByteString

this[int]

public byte this[int index] { get; }

Returns the byte at index index.

Parameter
Name Description
index int

The index in the blob to return. Must be greater than or equal to 0, and less than Length.
Property Value
Type Description
byte

The byte at index index.

Length

public int Length { get; }

The length of the blob, in bytes.

Property Value
Type Description
int

Methods

CopyFrom(byte[])

public static Blob CopyFrom(byte[] bytes)

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

Parameter
Name Description
bytes byte

Byte array to copy.
Returns
Type Description
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
Name Description
byteString ByteString

The ByteString to wrap. Must not be null.
Returns
Type Description
Blob

A new blob wrapping byteString.

GetHashCode()

public override int GetHashCode()
Returns
Type Description
int
Overrides

ToString()

public override string ToString()
Returns
Type Description
string
Overrides

Operators

operator ==(Blob, Blob)

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

Operator overload to compare two Blob values for equality.

Parameters
Name Description
lhs Blob

Left value to compare
rhs Blob

Right value to compare
Returns
Type Description
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
Name Description
lhs Blob

Left value to compare
rhs Blob

Right value to compare
Returns
Type Description
bool

false if lhs is equal to rhs; otherwise true.