Struct OctetString

Source
pub struct OctetString<'a> { /* private fields */ }
Expand description

ASN.1 OCTETSTRING type

This objects implements Copy-On-Write over data:

  • when parsing primitive form, parser will return a shared object
  • when parsing primitive form, parser must allocate memory

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

Implementations§

Source§

impl<'a> OctetString<'a>

Source

pub const fn new(s: &'a [u8]) -> Self

Source

pub fn as_cow(&'a self) -> &'a Cow<'a, [u8]>

Get the bytes representation of the content

Source

pub fn into_cow(self) -> Cow<'a, [u8]>

Get the bytes representation of the content

Trait Implementations§

Source§

impl Appendable for OctetString<'_>

Source§

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

Source§

impl AsRef<[u8]> for OctetString<'_>

Source§

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

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

impl<'i> BerParser<'i> for OctetString<'i>

Source§

type Error = BerError<Input<'i>>

The Error type for parsing errors.
Source§

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. Read more
Source§

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

Attempt to parse a new BER object from data. Read more
Source§

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

Source§

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
Source§

impl CheckDerConstraints for OctetString<'_>

Source§

impl<'a> Debug for OctetString<'a>

Source§

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

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

impl<'a> Default for OctetString<'a>

Source§

fn default() -> OctetString<'a>

Returns the “default value” for a type. Read more
Source§

impl<'i> DerParser<'i> for OctetString<'i>

Source§

type Error = BerError<Input<'i>>

The Error type for parsing errors.
Source§

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. Read more
Source§

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

Attempt to parse a new DER object from data. Read more
Source§

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

Source§

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
Source§

impl<'a> From<&'a [u8]> for OctetString<'a>

Source§

fn from(b: &'a [u8]) -> Self

Converts to this type from the input type.
Source§

impl<'a> PartialEq for OctetString<'a>

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Tagged for OctetString<'_>

Source§

const TAG: Tag = Tag::OctetString

Source§

const CLASS: Class = Class::Universal

Source§

const CONSTRUCTED: bool = false

Source§

impl ToBer for OctetString<'_>

Source§

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

Source§

fn ber_content_len(&self) -> Length

Returns the length of the encoded content of the object Read more
Source§

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

Encode and write the content of the object to the writer target Read more
Source§

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

Return the tag information to be encoded in header
Source§

fn ber_total_len(&self) -> Length

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

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

Encode and write the header of the object to the writer target Read more
Source§

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

Encode and write the object (header + content) to the writer target Read more
Source§

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 Read more
Source§

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 Read more
Source§

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

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

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

Encode in BER and write the object (header + content) to the writer target Read more
Source§

impl<'a> ToDer for OctetString<'a>
where OctetString<'a>: ToBer,

Source§

type Encoder = <OctetString<'a> as ToBer>::Encoder

Source§

fn der_content_len(&self) -> Length

Returns the length of the encoded content of the object Read more
Source§

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

Return the tag information to be encoded in header
Source§

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

Encode and write the content of the object to the writer target Read more
Source§

fn der_total_len(&self) -> Length

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

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

Encode and write the header of the object to the writer target Read more
Source§

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

Encode and write the object (header + content) to the writer target Read more
Source§

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 Read more
Source§

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 Read more
Source§

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

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

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

Encode in DER and write the object (header + content) to the writer target Read more
Source§

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
Source§

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

👎Deprecated since 0.8.0: Use to_der_vec() instead.
Source§

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

Source§

type Error = Error

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

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

Performs the conversion.
Source§

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

Source§

type Error = Error

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

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

Performs the conversion.
Source§

impl DerAutoDerive for OctetString<'_>

Source§

impl<'a> Eq for OctetString<'a>

Source§

impl<'a> StructuralPartialEq for OctetString<'a>

Auto Trait Implementations§

§

impl<'a> Freeze for OctetString<'a>

§

impl<'a> RefUnwindSafe for OctetString<'a>

§

impl<'a> Send for OctetString<'a>

§

impl<'a> Sync for OctetString<'a>

§

impl<'a> Unpin for OctetString<'a>

§

impl<'a> UnwindSafe for OctetString<'a>

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<A, T> AsBits<T> for A
where A: AsRef<[T]>, T: BitStore,

Source§

fn as_bits<O>(&self) -> &BitSlice<T, O>
where O: BitOrder,

Views self as an immutable bit-slice region with the O ordering.
Source§

fn try_as_bits<O>(&self) -> Result<&BitSlice<T, O>, BitSpanError<T>>
where O: BitOrder,

Attempts to view self as an immutable bit-slice region with the O ordering. Read more
Source§

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: BerParser<'a, Error = E>,

Source§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

Source§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: BerParser<'a, Error = E>,

Source§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

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<T> Choice for T
where T: Tagged,

Source§

fn can_decode(tag: Tag) -> bool

Is the provided Tag decodable as a variant of this CHOICE?
Source§

impl<T> Conv for T

Source§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
Source§

impl<T> DynTagged for T
where T: Tagged,

Source§

fn class(&self) -> Class

Return the class of the object
Source§

fn constructed(&self) -> bool

Return true if the object is constructed
Source§

fn tag(&self) -> Tag

Return the tag number of the object
Source§

fn accept_tag(tag: Tag) -> bool

Return true if the tag number is acceptable for this object Read more
Source§

impl<T> FmtForward for T

Source§

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
Source§

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
Source§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
Source§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
Source§

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
Source§

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
Source§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
Source§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
Source§

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<'a, T, E> FromBer<'a, E> for T
where T: TryFrom<Any<'a>, Error = E>, E: From<Error>,

Source§

fn from_ber(bytes: &'a [u8]) -> Result<(&'a [u8], T), Err<E>>

Attempt to parse input bytes into a BER object
Source§

impl<'a, T, E> FromDer<'a, E> for T
where T: TryFrom<Any<'a>, Error = E> + CheckDerConstraints + DerAutoDerive, E: From<Error> + Display + Debug,

Source§

fn from_der(bytes: &'a [u8]) -> Result<(&'a [u8], T), Err<E>>

Attempt to parse input bytes into a DER object (enforcing constraints)
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> Pipe for T
where T: ?Sized,

Source§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
Source§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
Source§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
Source§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
Source§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
Source§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
Source§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
Source§

impl<T> Tap for T

Source§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
Source§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
Source§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
Source§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
Source§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
Source§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
Source§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
Source§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
Source§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
Source§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
Source§

impl<T> TryConv for T

Source§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

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>,

Source§

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.