Struct der::asn1::BitStringRef

source ·
pub struct BitStringRef<'a> { /* private fields */ }
Expand description

ASN.1 BIT STRING type.

This type contains a sequence of any number of bits, modeled internally as a sequence of bytes with a known number of “unused bits”.

This is a zero-copy reference type which borrows from the input data.

Implementations§

source§

impl<'a> BitStringRef<'a>

source

pub const MAX_UNUSED_BITS: u8 = 7u8

Maximum number of unused bits allowed.

source

pub fn new(unused_bits: u8, bytes: &'a [u8]) -> Result<Self>

Create a new ASN.1 BIT STRING from a byte slice.

Accepts an optional number of “unused bits” (0-7) which are omitted from the final octet. This number is 0 if the value is octet-aligned.

source

pub fn from_bytes(bytes: &'a [u8]) -> Result<Self>

Create a new ASN.1 BIT STRING from the given bytes.

The “unused bits” are set to 0.

source

pub fn unused_bits(&self) -> u8

Get the number of unused bits in this byte slice.

source

pub fn has_unused_bits(&self) -> bool

Is the number of unused bits a value other than 0?

source

pub fn bit_len(&self) -> usize

Get the length of this BIT STRING in bits.

source

pub fn byte_len(&self) -> Length

Get the number of bytes/octets needed to represent this BIT STRING when serialized in an octet-aligned manner.

source

pub fn is_empty(&self) -> bool

Is the inner byte slice empty?

source

pub fn as_bytes(&self) -> Option<&'a [u8]>

Borrow the inner byte slice.

Returns None if the number of unused bits is not equal to zero, i.e. if the BIT STRING is not octet aligned.

Use BitString::raw_bytes to obtain access to the raw value regardless of the presence of unused bits.

source

pub fn raw_bytes(&self) -> &'a [u8]

Borrow the raw bytes of this BIT STRING.

Note that the byte string may contain extra unused bits in the final octet. If the number of unused bits is expected to be 0, the BitStringRef::as_bytes function can be used instead.

source

pub fn bits(self) -> BitStringIter<'a>

Iterator over the bits of this BIT STRING.

Trait Implementations§

source§

impl<'a> Clone for BitStringRef<'a>

source§

fn clone(&self) -> BitStringRef<'a>

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl<'a> Debug for BitStringRef<'a>

source§

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

Formats the value using the given formatter. Read more
source§

impl<'a> DecodeValue<'a> for BitStringRef<'a>

source§

fn decode_value<R: Reader<'a>>(reader: &mut R, header: Header) -> Result<Self>

Attempt to decode this message using the provided Reader.
source§

impl EncodeValue for BitStringRef<'_>

source§

fn value_len(&self) -> Result<Length>

Compute the length of this value (sans Tag+Length header) when encoded as ASN.1 DER.
source§

fn encode_value(&self, writer: &mut dyn Writer) -> Result<()>

Encode value (sans Tag+Length header) as ASN.1 DER using the provided Writer.
source§

fn header(&self) -> Result<Header>
where Self: Tagged,

Get the Header used to encode this value.
source§

impl<'a> FixedTag for BitStringRef<'a>

source§

const TAG: Tag = Tag::BitString

ASN.1 tag
source§

impl<'a> From<&'a BitString> for BitStringRef<'a>

source§

fn from(bit_string: &'a BitString) -> BitStringRef<'a>

Converts to this type from the input type.
source§

impl<'a> From<&BitStringRef<'a>> for BitStringRef<'a>

source§

fn from(value: &BitStringRef<'a>) -> BitStringRef<'a>

Converts to this type from the input type.
source§

impl<'a> Ord for BitStringRef<'a>

source§

fn cmp(&self, other: &BitStringRef<'a>) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized + PartialOrd,

Restrict a value to a certain interval. Read more
source§

impl<'a> PartialEq for BitStringRef<'a>

source§

fn eq(&self, other: &BitStringRef<'a>) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl<'a> PartialOrd for BitStringRef<'a>

source§

fn partial_cmp(&self, other: &BitStringRef<'a>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

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

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

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

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

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

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

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

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more
source§

impl<'a> TryFrom<&&'a [u8]> for BitStringRef<'a>

Hack for simplifying the custom derive use case.

§

type Error = Error

The type returned in the event of a conversion error.
source§

fn try_from(bytes: &&'a [u8]) -> Result<BitStringRef<'a>>

Performs the conversion.
source§

impl<'a> TryFrom<&'a [u8]> for BitStringRef<'a>

§

type Error = Error

The type returned in the event of a conversion error.
source§

fn try_from(bytes: &'a [u8]) -> Result<BitStringRef<'a>>

Performs the conversion.
source§

impl<'a> TryFrom<AnyRef<'a>> for BitStringRef<'a>

§

type Error = Error

The type returned in the event of a conversion error.
source§

fn try_from(any: AnyRef<'a>) -> Result<BitStringRef<'a>>

Performs the conversion.
source§

impl<'a> TryFrom<BitStringRef<'a>> for &'a [u8]

§

type Error = Error

The type returned in the event of a conversion error.
source§

fn try_from(bit_string: BitStringRef<'a>) -> Result<&'a [u8]>

Performs the conversion.
source§

impl ValueOrd for BitStringRef<'_>

source§

fn value_cmp(&self, other: &Self) -> Result<Ordering>

Return an Ordering between value portion of TLV-encoded self and other when serialized as ASN.1 DER.
source§

impl<'a> Copy for BitStringRef<'a>

source§

impl<'a> Eq for BitStringRef<'a>

source§

impl<'a> StructuralPartialEq for BitStringRef<'a>

Auto Trait Implementations§

§

impl<'a> RefUnwindSafe for BitStringRef<'a>

§

impl<'a> Send for BitStringRef<'a>

§

impl<'a> Sync for BitStringRef<'a>

§

impl<'a> Unpin for BitStringRef<'a>

§

impl<'a> UnwindSafe for BitStringRef<'a>

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<'a, T> Choice<'a> for T
where T: Decode<'a> + FixedTag,

source§

fn can_decode(tag: Tag) -> bool

Is the provided Tag decodable as a variant of this CHOICE?
source§

impl<'a, T> Decode<'a> for T
where T: DecodeValue<'a> + FixedTag,

source§

fn decode<R>(reader: &mut R) -> Result<T, Error>
where R: Reader<'a>,

Attempt to decode this message using the provided decoder.
source§

fn from_der(bytes: &'a [u8]) -> Result<Self>

Parse Self from the provided DER-encoded byte slice.
source§

impl<T> DerOrd for T

source§

fn der_cmp(&self, other: &T) -> Result<Ordering, Error>

Return an Ordering between self and other when serialized as ASN.1 DER.
source§

impl<T> Encode for T
where T: EncodeValue + Tagged,

source§

fn encoded_len(&self) -> Result<Length, Error>

Compute the length of this value in bytes when encoded as ASN.1 DER.

source§

fn encode(&self, writer: &mut dyn Writer) -> Result<(), Error>

Encode this value as ASN.1 DER using the provided Writer.

source§

fn encode_to_slice<'a>(&self, buf: &'a mut [u8]) -> Result<&'a [u8]>

Encode this value to the provided byte slice, returning a sub-slice containing the encoded message.
source§

fn encode_to_vec(&self, buf: &mut Vec<u8>) -> Result<Length>

Encode this message as ASN.1 DER, appending it to the provided byte vector.
source§

fn to_vec(&self) -> Result<Vec<u8>>

Serialize this message as a byte vector.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> Tagged for T
where T: FixedTag,

source§

fn tag(&self) -> Tag

Get the ASN.1 tag that this type is encoded with.
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> DecodeOwned for T
where T: for<'a> Decode<'a>,