pub struct AnyRef<'a> { /* private fields */ }
Available on crate feature pkcs8 only.
Expand description

ASN.1 ANY: represents any explicitly tagged ASN.1 value.

This is a zero-copy reference type which borrows from the input data.

Technically ANY hasn’t been a recommended part of ASN.1 since the X.209 revision from 1988. It was deprecated and replaced by Information Object Classes in X.680 in 1994, and X.690 no longer refers to it whatsoever.

Nevertheless, this crate defines an ANY type as it remains a familiar and useful concept which is still extensively used in things like PKI-related RFCs.

Implementations§

§

impl<'a> AnyRef<'a>

pub const NULL: AnyRef<'a> = Self{ tag: Tag::Null, value: ByteSlice::EMPTY,}

AnyRef representation of the ASN.1 NULL type.

pub fn new(tag: Tag, bytes: &'a [u8]) -> Result<AnyRef<'a>, Error>

Create a new AnyRef from the provided Tag and DER bytes.

pub fn value(self) -> &'a [u8]

Get the raw value for this AnyRef type as a byte slice.

pub fn decode_into<T>(self) -> Result<T, Error>where
    T: DecodeValue<'a> + FixedTag,

Attempt to decode this AnyRef type into the inner value.

pub fn is_null(self) -> bool

Is this value an ASN.1 NULL value?

pub fn bit_string(self) -> Result<BitStringRef<'a>, Error>

Attempt to decode an ASN.1 BIT STRING.

pub fn context_specific<T>(self) -> Result<ContextSpecific<T>, Error>where
    T: Decode<'a>,

Attempt to decode an ASN.1 CONTEXT-SPECIFIC field.

pub fn generalized_time(self) -> Result<GeneralizedTime, Error>

Attempt to decode an ASN.1 GeneralizedTime.

pub fn ia5_string(self) -> Result<Ia5StringRef<'a>, Error>

Attempt to decode an ASN.1 IA5String.

pub fn octet_string(self) -> Result<OctetStringRef<'a>, Error>

Attempt to decode an ASN.1 OCTET STRING.

pub fn oid(self) -> Result<ObjectIdentifier, Error>

Available on crate feature oid only.

Attempt to decode an ASN.1 OBJECT IDENTIFIER.

pub fn optional<T>(self) -> Result<Option<T>, Error>where
    T: Choice<'a> + TryFrom<AnyRef<'a>, Error = Error>,

Attempt to decode an ASN.1 OPTIONAL value.

pub fn printable_string(self) -> Result<PrintableStringRef<'a>, Error>

Attempt to decode an ASN.1 PrintableString.

pub fn teletex_string(self) -> Result<TeletexStringRef<'a>, Error>

Attempt to decode an ASN.1 TeletexString.

pub fn videotex_string(self) -> Result<VideotexStringRef<'a>, Error>

Attempt to decode an ASN.1 VideotexString.

pub fn sequence<F, T>(self, f: F) -> Result<T, Error>where
    F: FnOnce(&mut SliceReader<'a>) -> Result<T, Error>,

Attempt to decode this value an ASN.1 SEQUENCE, creating a new nested reader and calling the provided argument with it.

pub fn utc_time(self) -> Result<UtcTime, Error>

Attempt to decode an ASN.1 UTCTime.

pub fn utf8_string(self) -> Result<Utf8StringRef<'a>, Error>

Attempt to decode an ASN.1 UTF8String.

Trait Implementations§

§

impl<'a> Choice<'a> for AnyRef<'a>

§

fn can_decode(_: Tag) -> bool

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

impl<'a> Clone for AnyRef<'a>

§

fn clone(&self) -> AnyRef<'a>

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
§

impl<'a> Debug for AnyRef<'a>

§

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

Formats the value using the given formatter. Read more
§

impl<'a> Decode<'a> for AnyRef<'a>

§

fn decode<R>(reader: &mut R) -> Result<AnyRef<'a>, Error>where
    R: Reader<'a>,

Attempt to decode this message using the provided decoder.
§

fn from_der(bytes: &'a [u8]) -> Result<Self, Error>

Parse Self from the provided DER-encoded byte slice.
§

impl EncodeValue for AnyRef<'_>

§

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 dyn 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<'a> From<&'a Any> for AnyRef<'a>

Available on crate feature alloc only.
§

fn from(any: &'a Any) -> AnyRef<'a>

Converts to this type from the input type.
§

impl<'a> From<&'a ObjectIdentifier> for AnyRef<'a>

§

fn from(oid: &'a ObjectIdentifier) -> AnyRef<'a>

Converts to this type from the input type.
§

impl<'a> From<()> for AnyRef<'a>

§

fn from(_: ()) -> AnyRef<'a>

Converts to this type from the input type.
§

impl<'a> From<Ia5StringRef<'a>> for AnyRef<'a>

§

fn from(printable_string: Ia5StringRef<'a>) -> AnyRef<'a>

Converts to this type from the input type.
§

impl<'a> From<Null> for AnyRef<'a>

§

fn from(_: Null) -> AnyRef<'a>

Converts to this type from the input type.
§

impl<'a> From<OctetStringRef<'a>> for AnyRef<'a>

§

fn from(octet_string: OctetStringRef<'a>) -> AnyRef<'a>

Converts to this type from the input type.
§

impl<'a> From<PrintableStringRef<'a>> for AnyRef<'a>

§

fn from(printable_string: PrintableStringRef<'a>) -> AnyRef<'a>

Converts to this type from the input type.
§

impl<'a> From<TeletexStringRef<'a>> for AnyRef<'a>

§

fn from(teletex_string: TeletexStringRef<'a>) -> AnyRef<'a>

Converts to this type from the input type.
§

impl<'a> From<Utf8StringRef<'a>> for AnyRef<'a>

§

fn from(printable_string: Utf8StringRef<'a>) -> AnyRef<'a>

Converts to this type from the input type.
§

impl<'a> From<VideotexStringRef<'a>> for AnyRef<'a>

§

fn from(printable_string: VideotexStringRef<'a>) -> AnyRef<'a>

Converts to this type from the input type.
§

impl From<bool> for AnyRef<'static>

§

fn from(value: bool) -> AnyRef<'static>

Converts to this type from the input type.
§

impl<'a> Ord for AnyRef<'a>

§

fn cmp(&self, other: &AnyRef<'a>) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval. Read more
§

impl<'a> PartialEq<AnyRef<'a>> for AnyRef<'a>

§

fn eq(&self, other: &AnyRef<'a>) -> 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.
§

impl<'a> PartialOrd<AnyRef<'a>> for AnyRef<'a>

§

fn partial_cmp(&self, other: &AnyRef<'a>) -> 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
§

impl Tagged for AnyRef<'_>

§

fn tag(&self) -> Tag

Get the ASN.1 tag that this type is encoded with.
§

impl<'a> TryFrom<&'a [u8]> for AnyRef<'a>

§

type Error = Error

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

fn try_from(bytes: &'a [u8]) -> Result<AnyRef<'a>, Error>

Performs the conversion.
§

impl TryFrom<AnyRef<'_>> for GeneralizedTime

§

type Error = Error

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

fn try_from(any: AnyRef<'_>) -> Result<GeneralizedTime, Error>

Performs the conversion.
§

impl TryFrom<AnyRef<'_>> for Null

§

type Error = Error

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

fn try_from(any: AnyRef<'_>) -> Result<Null, Error>

Performs the conversion.
§

impl TryFrom<AnyRef<'_>> for ObjectIdentifier

§

type Error = Error

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

fn try_from(any: AnyRef<'_>) -> Result<ObjectIdentifier, Error>

Performs the conversion.
§

impl TryFrom<AnyRef<'_>> for UtcTime

§

type Error = Error

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

fn try_from(any: AnyRef<'_>) -> Result<UtcTime, Error>

Performs the conversion.
§

impl<'a> TryFrom<AnyRef<'a>> for &'a str

§

type Error = Error

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

fn try_from(any: AnyRef<'a>) -> Result<&'a str, Error>

Performs the conversion.
§

impl<'a> TryFrom<AnyRef<'a>> for BitStringRef<'a>

§

type Error = Error

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

fn try_from(any: AnyRef<'a>) -> Result<BitStringRef<'a>, Error>

Performs the conversion.
§

impl<'a, T> TryFrom<AnyRef<'a>> for ContextSpecific<T>where
    T: Decode<'a>,

§

type Error = Error

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

fn try_from(any: AnyRef<'a>) -> Result<ContextSpecific<T>, Error>

Performs the conversion.
§

impl<'a> TryFrom<AnyRef<'a>> for Ia5StringRef<'a>

§

type Error = Error

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

fn try_from(any: AnyRef<'a>) -> Result<Ia5StringRef<'a>, Error>

Performs the conversion.
§

impl<'a> TryFrom<AnyRef<'a>> for OctetStringRef<'a>

§

type Error = Error

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

fn try_from(any: AnyRef<'a>) -> Result<OctetStringRef<'a>, Error>

Performs the conversion.
§

impl<'a> TryFrom<AnyRef<'a>> for PrintableStringRef<'a>

§

type Error = Error

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

fn try_from(any: AnyRef<'a>) -> Result<PrintableStringRef<'a>, Error>

Performs the conversion.
§

impl<'a> TryFrom<AnyRef<'a>> for TeletexStringRef<'a>

§

type Error = Error

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

fn try_from(any: AnyRef<'a>) -> Result<TeletexStringRef<'a>, Error>

Performs the conversion.
§

impl<'a> TryFrom<AnyRef<'a>> for UIntRef<'a>

§

type Error = Error

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

fn try_from(any: AnyRef<'a>) -> Result<UIntRef<'a>, Error>

Performs the conversion.
§

impl<'a> TryFrom<AnyRef<'a>> for Utf8StringRef<'a>

§

type Error = Error

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

fn try_from(any: AnyRef<'a>) -> Result<Utf8StringRef<'a>, Error>

Performs the conversion.
§

impl<'a> TryFrom<AnyRef<'a>> for VideotexStringRef<'a>

§

type Error = Error

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

fn try_from(any: AnyRef<'a>) -> Result<VideotexStringRef<'a>, Error>

Performs the conversion.
§

impl ValueOrd for AnyRef<'_>

§

fn value_cmp(&self, other: &AnyRef<'_>) -> Result<Ordering, Error>

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

impl<'a> Copy for AnyRef<'a>

§

impl<'a> Eq for AnyRef<'a>

§

impl<'a> StructuralEq for AnyRef<'a>

§

impl<'a> StructuralPartialEq for AnyRef<'a>

Auto Trait Implementations§

§

impl<'a> RefUnwindSafe for AnyRef<'a>

§

impl<'a> Send for AnyRef<'a>

§

impl<'a> Sync for AnyRef<'a>

§

impl<'a> Unpin for AnyRef<'a>

§

impl<'a> UnwindSafe for AnyRef<'a>

Blanket Implementations§

source§

impl<T> Any for Twhere
    T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere
    T: ?Sized,

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere
    T: ?Sized,

const: unstable · source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<T> DerOrd for Twhere
    T: EncodeValue + ValueOrd + Tagged,

§

fn der_cmp(&self, other: &T) -> Result<Ordering, Error>

Return an Ordering between self and other when serialized as ASN.1 DER.
§

impl<T> Encode for Twhere
    T: EncodeValue + Tagged,

§

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

Compute the length of this value in bytes when encoded as ASN.1 DER.

§

fn encode(&self, writer: &mut dyn Writer) -> Result<(), Error>

Encode this value as ASN.1 DER using the provided Writer.

§

fn encode_to_slice<'a>(&self, buf: &'a mut [u8]) -> Result<&'a [u8], Error>

Encode this value to the provided byte slice, returning a sub-slice containing the encoded message.
§

fn encode_to_vec(&self, buf: &mut Vec<u8, Global>) -> Result<Length, Error>

Available on crate feature alloc only.
Encode this message as ASN.1 DER, appending it to the provided byte vector.
§

fn to_vec(&self) -> Result<Vec<u8, Global>, Error>

Available on crate feature alloc only.
Serialize this message as a byte vector.
source§

impl<T> From<T> for T

const: unstable · source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere
    U: From<T>,

const: unstable · 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> Same<T> for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for Twhere
    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 Twhere
    U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
const: unstable · source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere
    U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
const: unstable · source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.