Struct der::asn1::BitString

pub struct BitString<'a> { /* private fields */ }

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”.

Implementations

impl<'a> BitString<'a>

pub const MAX_UNUSED_BITS: u8 = 7u8

Maximum number of unused bits allowed.

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.

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.

pub fn unused_bits(&self) -> u8

Get the number of unused bits in this byte slice.

pub fn has_unused_bits(&self) -> bool

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

pub fn bit_len(&self) -> usize

Get the length of this BIT STRING in bits.

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.

pub fn is_empty(&self) -> bool

Is the inner byte slice empty?

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.

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 BitString::as_bytes function can be used instead.

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

Iterator over the bits of this BIT STRING.

Trait Implementations

impl<'a> Clone for BitString<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for BitString<'a>

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

Formats the value using the given formatter.

impl<'a> DecodeValue<'a> for BitString<'a>

fn decode_value(decoder: &mut Decoder<'a>, encoded_len: Length) -> Result<Self>

Attempt to decode this message using the provided Decoder.

impl EncodeValue for BitString<'_>

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

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

fn encode_value(&self, encoder: &mut Encoder<'_>) -> Result<()>

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

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

Get the Header used to encode this value.

impl<'a> FixedTag for BitString<'a>

const TAG: Tag = Tag::BitString

ASN.1 tag

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

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

Converts to this type from the input type.

impl<'a> Ord for BitString<'a>

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl<'a> PartialEq<BitString<'a>> for BitString<'a>

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

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

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.

impl<'a> PartialOrd<BitString<'a>> for BitString<'a>

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

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

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

Hack for simplifying the custom derive use case.

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<'a> TryFrom<Any<'a>> for BitString<'a>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(any: Any<'a>) -> Result<BitString<'a>>

Performs the conversion.

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

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl ValueOrd for BitString<'_>

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.

impl<'a> Copy for BitString<'a>

impl<'a> Eq for BitString<'a>

impl<'a> StructuralEq for BitString<'a>

impl<'a> StructuralPartialEq for BitString<'a>