Struct der::asn1::BitString

source ·
pub struct BitString { /* private fields */ }
Expand description

Owned form of ASN.1 BIT STRING type.

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

Implementations§

source§

impl BitString

source

pub const MAX_UNUSED_BITS: u8 = 7u8

Maximum number of unused bits allowed.

source

pub fn new(unused_bits: u8, bytes: impl Into<Vec<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: &[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 the octet serialization of this BIT STRING.

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

Is the inner byte slice empty?

source

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.

source

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

Borrow the raw bytes of this BIT STRING.

source

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

Iterator over the bits of this BIT STRING.

Trait Implementations§

source§

impl Clone for BitString

source§

fn clone(&self) -> BitString

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 Debug for BitString

source§

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

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

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

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 BitString

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 impl 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 FixedTag for BitString

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 Ord for BitString

source§

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

§

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

The resulting type referencing back to Self
source§

fn owned_to_ref(&self) -> Self::Borrowed<'_>

Creates a new object referencing back to the self for storage
source§

impl PartialEq for BitString

source§

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

source§

fn partial_cmp(&self, other: &BitString) -> 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<'__der> TryFrom<&'__der Any> for BitString

§

type Error = Error

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

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

Performs the conversion.
source§

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

§

type Error = Error

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

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

Performs the conversion.
source§

impl ValueOrd for BitString

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 Eq for BitString

source§

impl StructuralPartialEq for BitString

Auto Trait Implementations§

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<T> CloneToUninit for T
where T: Clone,

source§

default unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
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 impl 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_der(&self) -> Result<Vec<u8>>

Encode this type as DER, returning 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>,