Struct BinaryEncodedScope

pub struct BinaryEncodedScope(/* private fields */);

A scope encoded using a custom binary encoding. See Scope for more information.

Example

Simply create a BinaryEncodedScope from a byte array (we’re using the byte 0x21 as a separator in this example):

let scope = BinaryEncodedScope::try_from(vec![0x00, 0x21, 0xDC, 0xAF].as_slice())?;
assert!(scope.elements(Some(0x21))?.eq(&vec![vec![0x00], vec![0xDC, 0xAF]]));

But note that the input array can’t be empty:

assert!(BinaryEncodedScope::try_from(vec![].as_slice()).is_err());

Implementations

impl BinaryEncodedScope

pub fn elements( &self, separator: Option<u8>, ) -> Result<Vec<&[u8]>, InvalidBinaryEncodedScopeError>

Return the individual elements (i.e., access ranges) of this scope.

If no separator is given (i.e. it is None), it is assumed that the scope consists of a single element and will be returned as such.

Pre-conditions

• If a separator is given, it may neither be the first nor last element of the scope.
• If a separator is given, it may not occur twice in a row in the scope.
• The scope must not be empty.

Post-conditions

• The returned vector will not be empty.
• None of its elements will be empty.
• If a separator is given, none of its elements will contain it.
• If no separator is given, the vector will consist of a single element, containing the whole binary-encoded scope.

Example

let simple = BinaryEncodedScope::try_from(vec![0xDC, 0x21, 0xAF].as_slice())?;
assert!(simple.elements(Some(0x21))?.eq(&vec![vec![0xDC], vec![0xAF]]));
assert!(simple.elements(None)?.eq(&vec![vec![0xDC, 0x21, 0xAF]]));
assert!(simple.elements(Some(0xDC)).is_err());

Errors

• If the binary encoded scope separated by the given separator is invalid in any way. This may be the case if:
  • The scope starts with a separator
  • The scope ends with a separator
  • The scope contains two separators in a row.

Panics

If the pre-condition that the scope isn’t empty is violated. This shouldn’t occur, as it’s an invariant of BinaryEncodedScope.

Trait Implementations

impl Clone for BinaryEncodedScope

fn clone(&self) -> BinaryEncodedScope

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BinaryEncodedScope

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

Formats the value using the given formatter.

impl From<BinaryEncodedScope> for Scope

fn from(value: BinaryEncodedScope) -> Self

Converts to this type from the input type.

impl Hash for BinaryEncodedScope

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 PartialEq for BinaryEncodedScope

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

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

const 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 Serialize for BinaryEncodedScope

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&[u8]> for BinaryEncodedScope

type Error = InvalidBinaryEncodedScopeError

The type returned in the event of a conversion error.

fn try_from(value: &[u8]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Scope> for BinaryEncodedScope

type Error = WrongSourceTypeError<Scope>

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Eq for BinaryEncodedScope

impl StructuralPartialEq for BinaryEncodedScope