Struct ByteString 

pub struct ByteString {
    pub value: Option<Vec<u8>>,
}

A sequence of octets.

Fields

value: Option<Vec<u8>>

Raw inner byte string values as an array of bytes.

Implementations

impl ByteString

pub fn null() -> ByteString

Create a null string (not the same as an empty string)

pub fn is_null(&self) -> bool

Test if the string is null

pub fn is_empty(&self) -> bool

Test if the bytestring has an empty value (not the same as null)

pub fn is_null_or_empty(&self) -> bool

Test if the string is null or empty

pub fn from_base64(data: &str) -> Option<ByteString>

Creates a byte string from a base64 encoded string

pub fn from_base64_ignore_whitespace(data: String) -> Option<ByteString>

Creates a byte string from a base64 encoded string, ignoring whitespace.

pub fn as_base64(&self) -> String

Encodes the bytestring as a base64 encoded string

pub fn substring( &self, min: usize, max: usize, ) -> Result<ByteString, OutOfRange>

This function is meant for use with NumericRange. It creates a substring from this string from min up to and inclusive of max. Note that min must have an index within the string but max is allowed to be beyond the end in which case the remainder of the string is returned (see docs for NumericRange).

pub fn len(&self) -> usize

Length of the byte string in bytes.

Trait Implementations

impl AsRef<[u8]> for ByteString

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for ByteString

fn clone(&self) -> ByteString

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ByteString

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ByteString

fn default() -> Self

Returns the “default value” for a type.

impl<'a, T> From<&'a T> for ByteString

where T: AsRef<[u8]> + ?Sized,

fn from(value: &'a T) -> Self

Converts to this type from the input type.

impl From<ByteString> for DataValue

fn from(v: ByteString) -> Self

Converts to this type from the input type.

impl From<ByteString> for Identifier

fn from(v: ByteString) -> Self

Converts to this type from the input type.

impl From<ByteString> for NodeId

fn from(value: ByteString) -> Self

Converts to this type from the input type.

impl From<ByteString> for String

fn from(value: ByteString) -> Self

Converts to this type from the input type.

impl From<Guid> for ByteString

fn from(value: Guid) -> Self

Converts to this type from the input type.

impl From<Vec<u8>> for ByteString

fn from(value: Vec<u8>) -> Self

Converts to this type from the input type.

impl Hash for ByteString

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl IdentifierRef for &ByteString

fn hash_as_identifier<H: Hasher>(&self, state: &mut H)

Hash the value as if it was in an identifier. This must result in the same hash as the equivalent identifier.

impl IdentifierRef for ByteString

fn hash_as_identifier<H: Hasher>(&self, state: &mut H)

Hash the value as if it was in an identifier. This must result in the same hash as the equivalent identifier.

impl IntoVariant for ByteString

fn into_variant(self) -> Variant

Convert self into a variant.

impl JsonDecodable for ByteString

fn decode( stream: &mut JsonStreamReader<&mut dyn Read>, _ctx: &Context<'_>, ) -> EncodingResult<Self>

Decode Self from a JSON stream.

impl JsonEncodable for ByteString

fn encode( &self, stream: &mut JsonStreamWriter<&mut dyn Write>, _ctx: &Context<'_>, ) -> EncodingResult<()>

Write the type to the provided JSON writer.

impl PartialEq<&[u8]> for ByteString

fn eq(&self, other: &&[u8]) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<[u8]> for ByteString

fn eq(&self, other: &[u8]) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<Identifier> for &ByteString

fn eq(&self, other: &Identifier) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<Identifier> for ByteString

fn eq(&self, other: &Identifier) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq for ByteString

fn eq(&self, other: &ByteString) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl SimpleBinaryDecodable for ByteString

fn decode<S: Read + ?Sized>( stream: &mut S, decoding_options: &DecodingOptions, ) -> EncodingResult<Self>

Decode Self from the byte stream.

impl SimpleBinaryEncodable for ByteString

fn byte_len(&self) -> usize

This may be called prior to writing to ensure the correct amount of space is available.

fn encode<S: Write + ?Sized>(&self, stream: &mut S) -> EncodingResult<()>

Encodes the instance to the write stream.

fn encode_to_vec(&self) -> Vec<u8>

Convenience method for encoding a message straight into an array of bytes. It is preferable to reuse buffers than to call this so it should be reserved for tests and trivial code.

impl TryFrom<&ByteString> for Guid

type Error = ()

The type returned in the event of a conversion error.

fn try_from(value: &ByteString) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFromVariant for ByteString

fn try_from_variant(v: Variant) -> Result<Self, Error>

Try to cast the given variant to this type.

impl UaNullable for ByteString

fn is_ua_null(&self) -> bool

Return true if this value is null, meaning it can be left out when being encoded in JSON and XML encodings.

impl VariantType for ByteString

fn variant_type_id() -> VariantScalarTypeId

The variant kind this type will be represented as.

impl XmlDecodable for ByteString

fn decode( read: &mut XmlStreamReader<&mut dyn Read>, _context: &Context<'_>, ) -> Result<Self, Error>

Decode a value from an XML stream.

impl XmlEncodable for ByteString

fn encode( &self, writer: &mut XmlStreamWriter<&mut dyn Write>, _context: &Context<'_>, ) -> EncodingResult<()>

Encode a value to an XML stream.

impl XmlType for ByteString

const TAG: &'static str = "ByteString"

The static fallback tag for this type. Convenience feature, but also used in nested types.

fn tag(&self) -> &str

The XML tag name for this type.

impl Eq for ByteString

impl StructuralPartialEq for ByteString