public sealed class ByteString : IEnumerable<byte>, IEquatable<ByteString>
Immutable array of bytes.
Implements
IEquatable < ByteString >Namespace
Google.ProtobufAssembly
Google.Protobuf.dll
Properties
Empty
public static ByteString Empty { get; }
Returns an empty ByteString.
IsEmpty
public bool IsEmpty { get; }
Returns true
if this byte string is empty, false
otherwise.
Item[Int32]
public
byte
this
[
int
index
]
{
get
;
}
Returns the byte at the given index.
Length
public int Length { get; }
Returns the length of this ByteString in bytes.
Memory
public ReadOnlyMemory<byte> Memory { get; }
Provides read-only access to the data of this ByteString . No data is copied so this is the most efficient way of accessing.
Span
public ReadOnlySpan<byte> Span { get; }
Provides read-only access to the data of this ByteString . No data is copied so this is the most efficient way of accessing.
Methods
CopyFrom(ReadOnlySpan<Byte>)
public static ByteString CopyFrom(ReadOnlySpan<byte> bytes)
Constructs a ByteString from a read only span. The contents are copied, so further modifications to the span will not be reflected in the returned ByteString .
CopyFrom(Byte[])
public static ByteString CopyFrom(params byte[] bytes)
Constructs a ByteString
from the given array. The contents
are copied, so further modifications to the array will not
be reflected in the returned ByteString.
This method can also be invoked in ByteString.CopyFrom(0xaa, 0xbb, ...)
form
which is primarily useful for testing.
CopyFrom(Byte[], Int32, Int32)
public static ByteString CopyFrom(byte[] bytes, int offset, int count)
Constructs a ByteString from a portion of a byte array.
CopyFrom(String, Encoding)
public static ByteString CopyFrom(string text, Encoding encoding)
Creates a new ByteString by encoding the specified text with the given encoding.
CopyFromUtf8(String)
public static ByteString CopyFromUtf8(string text)
Creates a new ByteString by encoding the specified text in UTF-8.
CopyTo(Byte[], Int32)
public void CopyTo(byte[] array, int position)
Copies the entire byte array to the destination array provided at the offset specified.
CreateCodedInput()
public CodedInputStream CreateCodedInput()
Creates a CodedInputStream from this ByteString's data.
Equals(ByteString)
public bool Equals(ByteString other)
Compares this byte string with another.
Equals(Object)
public override bool Equals(object obj)
Compares this byte string with another object.
FromBase64(String)
public static ByteString FromBase64(string bytes)
Constructs a ByteString from the Base64 Encoded String.
FromStream(Stream)
public static ByteString FromStream(Stream stream)
Constructs a ByteString from data in the given stream, synchronously.
stream
Stream
The stream to copy into a ByteString.
If successful, stream
will be read completely, from the position
at the start of the call.
FromStreamAsync(Stream, CancellationToken)
public static Task<ByteString> FromStreamAsync(Stream stream, CancellationToken cancellationToken = null)
Constructs a ByteString from data in the given stream, asynchronously.
stream
Stream
The stream to copy into a ByteString.
cancellationToken
CancellationToken
The cancellation token to use when reading from the stream, if any.
If successful, stream
will be read completely, from the position
at the start of the call.
GetEnumerator()
public IEnumerator<byte> GetEnumerator()
Returns an iterator over the bytes in this ByteString .
GetHashCode()
public override int GetHashCode()
Returns a hash code for this object. Two equal byte strings will return the same hash code.
ToBase64()
public string ToBase64()
Converts this ByteString into a standard base64 representation.
ToByteArray()
public byte[] ToByteArray()
Converts this ByteString into a byte array.
The data is copied - changes to the returned array will not be reflected in this ByteString
.
ToString(Encoding)
public string ToString(Encoding encoding)
Converts this ByteString into a string by applying the given encoding.
encoding
Encoding
The encoding to use to decode the binary data into text.
This method should only be used to convert binary data which was the result of encoding text with the given encoding.
ToStringUtf8()
public string ToStringUtf8()
Converts this ByteString into a string by applying the UTF-8 encoding.
This method should only be used to convert binary data which was the result of encoding text with UTF-8.
WriteTo(Stream)
public void WriteTo(Stream outputStream)
Writes the entire byte array to the provided stream
outputStream
Stream
Operators
Equality(ByteString, ByteString)
public static bool operator ==(ByteString lhs, ByteString rhs)
Compares two byte strings for equality.
lhs
rhs
Inequality(ByteString, ByteString)
public static bool operator !=(ByteString lhs, ByteString rhs)
Compares two byte strings for inequality.
lhs
rhs
