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>
impl<'a> BitStringRef<'a>
sourcepub const MAX_UNUSED_BITS: u8 = 7u8
pub const MAX_UNUSED_BITS: u8 = 7u8
Maximum number of unused bits allowed.
sourcepub fn new(unused_bits: u8, bytes: &'a [u8]) -> Result<Self>
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.
sourcepub fn from_bytes(bytes: &'a [u8]) -> Result<Self>
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.
sourcepub fn unused_bits(&self) -> u8
pub fn unused_bits(&self) -> u8
Get the number of unused bits in this byte slice.
sourcepub fn has_unused_bits(&self) -> bool
pub fn has_unused_bits(&self) -> bool
Is the number of unused bits a value other than 0?
sourcepub fn byte_len(&self) -> Length
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.
sourcepub fn as_bytes(&self) -> Option<&'a [u8]>
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.
sourcepub fn raw_bytes(&self) -> &'a [u8]
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.
sourcepub fn bits(self) -> BitStringIter<'a> ⓘ
pub fn bits(self) -> BitStringIter<'a> ⓘ
Iterator over the bits of this BIT STRING
.
Trait Implementations§
source§impl<'a> Clone for BitStringRef<'a>
impl<'a> Clone for BitStringRef<'a>
source§fn clone(&self) -> BitStringRef<'a>
fn clone(&self) -> BitStringRef<'a>
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl<'a> Debug for BitStringRef<'a>
impl<'a> Debug for BitStringRef<'a>
source§impl<'a> DecodeValue<'a> for BitStringRef<'a>
impl<'a> DecodeValue<'a> for BitStringRef<'a>
source§impl EncodeValue for BitStringRef<'_>
impl EncodeValue for BitStringRef<'_>
source§impl<'a> From<&'a BitString> for BitStringRef<'a>
impl<'a> From<&'a BitString> for BitStringRef<'a>
source§fn from(bit_string: &'a BitString) -> BitStringRef<'a>
fn from(bit_string: &'a BitString) -> BitStringRef<'a>
source§impl<'a> From<&BitStringRef<'a>> for BitStringRef<'a>
impl<'a> From<&BitStringRef<'a>> for BitStringRef<'a>
source§fn from(value: &BitStringRef<'a>) -> BitStringRef<'a>
fn from(value: &BitStringRef<'a>) -> BitStringRef<'a>
source§impl<'a> Ord for BitStringRef<'a>
impl<'a> Ord for BitStringRef<'a>
source§fn cmp(&self, other: &BitStringRef<'a>) -> Ordering
fn cmp(&self, other: &BitStringRef<'a>) -> Ordering
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere
Self: Sized,
source§impl<'a> PartialEq for BitStringRef<'a>
impl<'a> PartialEq for BitStringRef<'a>
source§fn eq(&self, other: &BitStringRef<'a>) -> bool
fn eq(&self, other: &BitStringRef<'a>) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl<'a> PartialOrd for BitStringRef<'a>
impl<'a> PartialOrd for BitStringRef<'a>
source§fn partial_cmp(&self, other: &BitStringRef<'a>) -> Option<Ordering>
fn partial_cmp(&self, other: &BitStringRef<'a>) -> Option<Ordering>
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresource§impl<'a> TryFrom<&&'a [u8]> for BitStringRef<'a>
impl<'a> TryFrom<&&'a [u8]> for BitStringRef<'a>
Hack for simplifying the custom derive use case.
source§impl<'a> TryFrom<&'a [u8]> for BitStringRef<'a>
impl<'a> TryFrom<&'a [u8]> for BitStringRef<'a>
source§impl<'a> TryFrom<AnyRef<'a>> for BitStringRef<'a>
impl<'a> TryFrom<AnyRef<'a>> for BitStringRef<'a>
source§impl<'a> TryFrom<BitStringRef<'a>> for &'a [u8]
impl<'a> TryFrom<BitStringRef<'a>> for &'a [u8]
source§impl ValueOrd for BitStringRef<'_>
impl ValueOrd for BitStringRef<'_>
impl<'a> Copy for BitStringRef<'a>
impl<'a> Eq for BitStringRef<'a>
impl<'a> StructuralPartialEq for BitStringRef<'a>
Auto Trait Implementations§
impl<'a> Freeze for BitStringRef<'a>
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> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)source§impl<T> CloneToUninit for Twhere
T: Copy,
impl<T> CloneToUninit for Twhere
T: Copy,
source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)source§impl<'a, T> Decode<'a> for Twhere
T: DecodeValue<'a> + FixedTag,
impl<'a, T> Decode<'a> for Twhere
T: DecodeValue<'a> + FixedTag,
source§impl<T> Encode for Twhere
T: EncodeValue + Tagged,
impl<T> Encode for Twhere
T: EncodeValue + Tagged,
source§fn encoded_len(&self) -> Result<Length, Error>
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>
fn encode(&self, writer: &mut dyn Writer) -> Result<(), Error>
Encode this value as ASN.1 DER using the provided Writer
.