Struct BitString

pub struct BitString { /* private fields */ }

ASN.1 BITSTRING type

This objects owns data (it makes one copy during parsing). Internally, it relies on BitVec.

Use BitString::as_bitslice to access content and BitString::as_mut_bitslice to modify content.

This type supports constructed objects, but all data segments are appended during parsing (i.e object structure is not kept after parsing).

Implementations

impl BitString

pub fn new(unused_bits: u8, s: &[u8]) -> Self

Build a new BitString

Safety

panic if unused_bits is greater than 7 or greater than input length

pub fn len(&self) -> usize

Gets the length of the BitString (number of bits)

pub fn is_empty(&self) -> bool

Tests if the BitString is empty

pub fn is_set(&self, bitnum: usize) -> bool

Test if bit bitnum is set

Return false if bit is not set, or if index is outside range.

pub fn as_bitslice(&self) -> &BitSlice<u8, Msb0>

Return a shared BitSlice over the object data.

pub fn as_mut_bitslice(&mut self) -> &mut BitSlice<u8, Msb0>

Return a mutable BitSlice over the object data.

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

Return a view over bit-slice bytes

Trait Implementations

impl Appendable for BitString

fn append(&mut self, other: &mut Self)

impl AsRef<[u8]> for BitString

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.

impl<'i> BerParser<'i> for BitString

type Error = BerError<Input<'i>>

The Error type for parsing errors.

fn from_ber_content( header: &Header<'i>, input: Input<'i>, ) -> IResult<Input<'i>, Self, Self::Error>

Parse a new BER object from header and data.

fn parse_ber(input: Input<'i>) -> IResult<Input<'i>, Self, Self::Error>

Attempt to parse a new BER object from data.

fn parse_ber_optional( input: Input<'i>, ) -> IResult<Input<'i>, Option<Self>, Self::Error>

fn parse_ber_as_input( input: Input<'i>, ) -> IResult<Input<'i>, (Header<'i>, Input<'i>), Self::Error>

Parse object header (validating tag) and return header and content as Input

impl CheckDerConstraints for BitString

fn check_constraints(any: &Any<'_>) -> Result<()>

impl Clone for BitString

fn clone(&self) -> BitString

Returns a copy 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

Formats the value using the given formatter.

impl Default for BitString

fn default() -> BitString

Returns the “default value” for a type.

impl<'i> DerParser<'i> for BitString

type Error = BerError<Input<'i>>

The Error type for parsing errors.

fn from_der_content( header: &Header<'i>, input: Input<'i>, ) -> IResult<Input<'i>, Self, Self::Error>

Parse a new DER object from header and data.

fn parse_der(input: Input<'i>) -> IResult<Input<'i>, Self, Self::Error>

Attempt to parse a new DER object from data.

fn parse_der_optional( input: Input<'i>, ) -> IResult<Input<'i>, Option<Self>, Self::Error>

fn parse_der_as_input( input: Input<'i>, ) -> IResult<Input<'i>, (Header<'i>, Input<'i>), Self::Error>

Parse object header (validating tag) and return header and content as Input

impl From<&BitSlice<u8, Msb0>> for BitString

fn from(slice: &BitSlice<u8, Msb0>) -> Self

Converts to this type from the input type.

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

const TAG: Tag = Tag::BitString

const CLASS: Class = Class::Universal

const CONSTRUCTED: bool = false

impl ToBer for BitString

type Encoder = Primitive<{ Tag::BitString.0 }>

fn ber_content_len(&self) -> Length

Returns the length of the encoded content of the object

fn ber_write_content<W: Write>(&self, target: &mut W) -> SerializeResult<usize>

Encode and write the content of the object to the writer target

fn ber_tag_info(&self) -> (Class, bool, Tag)

Return the tag information to be encoded in header

fn ber_total_len(&self) -> Length

Returns the total length (including header) of the encoded content of the object

fn ber_write_header<W: Write>(&self, target: &mut W) -> SerializeResult<usize>

Encode and write the header of the object to the writer target

fn ber_encode<W: Write>(&self, target: &mut W) -> SerializeResult<usize>

Encode and write the object (header + content) to the writer target

fn ber_encode_tagged_explicit<W: Write>( &self, class: Class, tag_number: u32, target: &mut W, ) -> SerializeResult<usize>

Encode and write the object (header + content) as TAGGED EXPLICIT and write it to the writer target

fn ber_encode_tagged_implicit<W: Write>( &self, class: Class, tag_number: u32, target: &mut W, ) -> SerializeResult<usize>

Encode and write the object (header + content) as TAGGED IMPLICIT and write it to the writer target

fn to_ber_vec(&self) -> SerializeResult<Vec<u8>>

Write the DER encoded representation to a newly allocated Vec<u8>

fn write_ber<W: Write>(&self, writer: &mut W) -> SerializeResult<usize>

Encode in BER and write the object (header + content) to the writer target

impl ToDer for BitString

where BitString: ToBer,

type Encoder = <BitString as ToBer>::Encoder

fn der_content_len(&self) -> Length

Returns the length of the encoded content of the object

fn der_tag_info(&self) -> (Class, bool, Tag)

Return the tag information to be encoded in header

fn der_write_content<W: Write>(&self, target: &mut W) -> SerializeResult<usize>

Encode and write the content of the object to the writer target

fn der_total_len(&self) -> Length

Returns the total length (including header) of the encoded content of the object

fn der_write_header<W: Write>(&self, target: &mut W) -> SerializeResult<usize>

Encode and write the header of the object to the writer target

fn der_encode<W: Write>(&self, target: &mut W) -> SerializeResult<usize>

Encode and write the object (header + content) to the writer target

fn der_encode_tagged_explicit<W: Write>( &self, class: Class, tag_number: u32, target: &mut W, ) -> SerializeResult<usize>

Encode and write the object (header + content) as TAGGED EXPLICIT and write it to the writer target

fn der_encode_tagged_implicit<W: Write>( &self, class: Class, tag_number: u32, target: &mut W, ) -> SerializeResult<usize>

Encode and write the object (header + content) as TAGGED IMPLICIT and write it to the writer target

fn to_der_vec(&self) -> SerializeResult<Vec<u8>>

Write the DER encoded representation to a newly allocated Vec<u8>

fn write_der<W: Write>(&self, writer: &mut W) -> SerializeResult<usize>

Encode in DER and write the object (header + content) to the writer target

fn to_der_len(&self) -> Result<usize>

👎Deprecated since 0.8.0: Use der_total_len() instead.

Get the length of the object (including the header), when encoded

fn to_der_vec_raw(&self) -> SerializeResult<Vec<u8>>

👎Deprecated since 0.8.0: Use to_der_vec() instead.

impl<'i, 'b> TryFrom<&'b Any<'i>> for BitString

type Error = Error

The type returned in the event of a conversion error.

fn try_from(any: &'b Any<'i>) -> Result<Self>

Performs the conversion.

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

type Error = Error

The type returned in the event of a conversion error.

fn try_from(any: Any<'i>) -> Result<Self>

Performs the conversion.

impl DerAutoDerive for BitString

impl Eq for BitString

impl StructuralPartialEq for BitString