Struct BitString 

pub struct BitString { /* private fields */ }

Available on crate feature pkcs8 only.

Owned form of ASN.1 BIT STRING type.

This type provides the same functionality as BitStringRef but owns the backing data.

Implementations

impl BitString

pub const MAX_UNUSED_BITS: u8 = 7

Maximum number of unused bits allowed.

pub fn new( unused_bits: u8, bytes: impl Into<Vec<u8>>, ) -> Result<BitString, Error>

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.

Errors

Returns Error if any of the following occur:

• unused_bits is invalid
• bytes is too long
• an overflow occurred calculating the bit length

pub fn from_bytes(bytes: &[u8]) -> Result<BitString, Error>

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

The “unused bits” are set to 0.

Errors

If bytes is too long.

pub fn unused_bits(&self) -> u8

Get the number of unused bits in the octet serialization of this BIT STRING.

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 is_empty(&self) -> bool

Is the inner byte slice empty?

pub fn as_bytes(&self) -> Option<&[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) -> &[u8]

Borrow the raw bytes of this BIT STRING.

pub fn bits(&self) -> BitStringIter<'_>

Iterator over the bits of this BIT STRING.

pub fn get(&self, position: usize) -> Option<bool>

Returns Some(bit) if index is valid

Trait Implementations

impl Clone for BitString

fn clone(&self) -> BitString

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BitString

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

Formats the value using the given formatter.

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

type Error = Error

Type returned in the event of a decoding error.

fn decode_value<R>(reader: &mut R, header: Header) -> Result<BitString, Error>

where R: Reader<'a>,

Attempt to decode this value using the provided Reader.

impl EncodeValue for BitString

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

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

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

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

fn header(&self) -> Result<Header, Error>

where Self: Tagged,

Get the Header used to encode this value.

impl FixedTag for BitString

const TAG: Tag = Tag::BitString

ASN.1 tag

impl From<&BitString> for Any

fn from(bit_string: &BitString) -> Any

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl From<BitString> for Any

fn from(bit_string: BitString) -> Any

Converts to this type from the input type.

impl Ord for BitString

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl OwnedToRef for BitString

type Borrowed<'a> = BitStringRef<'a>

The resulting type referencing back to Self

fn owned_to_ref(&self) -> <BitString as OwnedToRef>::Borrowed<'_>

Creates a new object referencing back to the self for storage

impl PartialEq for BitString

fn eq(&self, other: &BitString) -> 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 PartialOrd for BitString

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl<'__der> TryFrom<&'__der Any> for BitString

Available on crate feature alloc only.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(any: &'__der Any) -> Result<BitString, Error>

Performs the conversion.

impl<'__der> TryFrom<AnyRef<'__der>> for BitString

type Error = Error

The type returned in the event of a conversion error.

fn try_from(any: AnyRef<'__der>) -> Result<BitString, Error>

Performs the conversion.

impl ValueOrd for BitString

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

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

impl Eq for BitString

impl StructuralPartialEq for BitString