Struct rocket::mtls::oid::asn1_rs::Sequence

pub struct Sequence<'a> {
    pub content: Cow<'a, [u8]>,
}
Available on crate feature mtls only.
Expand description

The SEQUENCE object is an ordered list of heteregeneous types.

Sequences can usually be of 2 types:

  • a list of different objects (SEQUENCE, usually parsed as a struct)
  • a list of similar objects (SEQUENCE OF, usually parsed as a Vec<T>)

The current object covers the former. For the latter, see the SequenceOf documentation.

The Sequence object contains the (unparsed) encoded representation of its content. It provides methods to parse and iterate contained objects, or convert the sequence to other types.

Building a Sequence

To build a DER sequence:

  • if the sequence is composed of objects of the same type, the Sequence::from_iter_to_der method can be used
  • otherwise, the ToDer trait can be used to create content incrementally
use asn1_rs::{Integer, Sequence, SerializeResult, ToDer};

fn build_seq<'a>() -> SerializeResult<Sequence<'a>> {
    let mut v = Vec::new();
    // add an Integer object (construct type):
    let i = Integer::from_u32(4);
    let _ = i.write_der(&mut v)?;
    // some primitive objects also implement `ToDer`. A string will be mapped as `Utf8String`:
    let _ = "abcd".write_der(&mut v)?;
    // return the sequence built from the DER content
    Ok(Sequence::new(v.into()))
}

let seq = build_seq().unwrap();

Examples

use asn1_rs::Sequence;

// build sequence
let it = [2, 3, 4].iter();
let seq = Sequence::from_iter_to_der(it).unwrap();

// `seq` now contains the serialized DER representation of the array

// iterate objects
let mut sum = 0;
for item in seq.der_iter::<u32>() {
    // item has type `Result<u32>`, since parsing the serialized bytes could fail
    sum += item.expect("parsing list item failed");
}
assert_eq!(sum, 9);

Note: the above example encodes a SEQUENCE OF INTEGER object, the SequenceOf object could be used to provide a simpler API.

Fields§

§content: Cow<'a, [u8]>

Serialized DER representation of the sequence content

Implementations§

§

impl<'a> Sequence<'a>

pub const fn new(content: Cow<'a, [u8]>) -> Sequence<'a>

Build a sequence, given the provided content

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

Consume the sequence and return the content

pub fn and_then<U, F>(self, op: F) -> Result<(&'a [u8], U), Err<Error>>where F: FnOnce(Cow<'a, [u8]>) -> Result<(&'a [u8], U), Err<Error>>,

Apply the parsing function to the sequence content, consuming the sequence

Note: this function expects the caller to take ownership of content. In some cases, handling the lifetime of objects is not easy (when keeping only references on data). Other methods are provided (depending on the use case):

  • Sequence::parse takes a reference on the sequence data, but does not consume it,
  • Sequence::from_der_and_then does the parsing of the sequence and applying the function in one step, ensuring there are only references (and dropping the temporary sequence).

pub fn from_ber_and_then<U, F>( bytes: &'a [u8], op: F ) -> Result<(&'a [u8], U), Err<Error>>where F: FnOnce(&'a [u8]) -> Result<(&'a [u8], U), Err<Error>>,

Same as Sequence::from_der_and_then, but using BER encoding (no constraints).

pub fn from_der_and_then<U, F>( bytes: &'a [u8], op: F ) -> Result<(&'a [u8], U), Err<Error>>where F: FnOnce(&'a [u8]) -> Result<(&'a [u8], U), Err<Error>>,

Parse a DER sequence and apply the provided parsing function to content

After parsing, the sequence object and header are discarded.

use asn1_rs::{FromDer, ParseResult, Sequence};

// Parse a SEQUENCE {
//      a INTEGER (0..255),
//      b INTEGER (0..4294967296)
// }
// and return only `(a,b)
fn parser(i: &[u8]) -> ParseResult<(u8, u32)> {
    Sequence::from_der_and_then(i, |i| {
            let (i, a) = u8::from_der(i)?;
            let (i, b) = u32::from_der(i)?;
            Ok((i, (a, b)))
        }
    )
}

pub fn parse<F, T>(&'a self, f: F) -> Result<(&'a [u8], T), Err<Error>>where F: FnMut(&'a [u8]) -> Result<(&'a [u8], T), Err<Error>>,

Apply the parsing function to the sequence content (non-consuming version)

pub fn parse_into<F, T>(self, f: F) -> Result<(&'a [u8], T), Err<Error>>where F: FnMut(&'a [u8]) -> Result<(&'a [u8], T), Err<Error>>,

Apply the parsing function to the sequence content (consuming version)

Note: to parse and apply a parsing function in one step, use the Sequence::from_der_and_then method.

Limitations

This function fails if the sequence contains Owned data, because the parsing function takes a reference on data (which is dropped).

pub fn ber_iter<T>(&'a self) -> SequenceIterator<'a, T, BerParser>where T: FromBer<'a>,

Return an iterator over the sequence content, attempting to decode objects as BER

This method can be used when all objects from the sequence have the same type.

pub fn der_iter<T>(&'a self) -> SequenceIterator<'a, T, DerParser>where T: FromDer<'a>,

Return an iterator over the sequence content, attempting to decode objects as DER

This method can be used when all objects from the sequence have the same type.

pub fn ber_sequence_of<T>(&'a self) -> Result<Vec<T>, Error>where T: FromBer<'a>,

Attempt to parse the sequence as a SEQUENCE OF items (BER), and return the parsed items as a Vec.

pub fn der_sequence_of<T>(&'a self) -> Result<Vec<T>, Error>where T: FromDer<'a>,

Attempt to parse the sequence as a SEQUENCE OF items (DER), and return the parsed items as a Vec.

pub fn into_ber_sequence_of<T, U>(self) -> Result<Vec<T>, Error>where T: for<'b> FromBer<'b> + ToStatic<Owned = T>,

Attempt to parse the sequence as a SEQUENCE OF items (BER) (consuming input), and return the parsed items as a Vec.

Note: if Self is an Owned object, the data will be duplicated (causing allocations) into separate objects.

pub fn into_der_sequence_of<T, U>(self) -> Result<Vec<T>, Error>where T: for<'b> FromDer<'b> + ToStatic<Owned = T>,

Attempt to parse the sequence as a SEQUENCE OF items (DER) (consuming input), and return the parsed items as a Vec.

Note: if Self is an Owned object, the data will be duplicated (causing allocations) into separate objects.

§

impl<'a> Sequence<'a>

pub fn from_iter_to_der<T, IT>(it: IT) -> Result<Sequence<'a>, SerializeError>where IT: Iterator<Item = T>, T: ToDer + Tagged,

Attempt to create a Sequence from an iterator over serializable objects (to DER)

Examples
use asn1_rs::Sequence;

// build sequence
let it = [2, 3, 4].iter();
let seq = Sequence::from_iter_to_der(it).unwrap();

Trait Implementations§

§

impl<'a> AsRef<[u8]> for Sequence<'a>

§

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

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

impl<'a> CheckDerConstraints for Sequence<'a>

§

fn check_constraints(_any: &Any<'_>) -> Result<(), Error>

§

impl<'a> Clone for Sequence<'a>

§

fn clone(&self) -> Sequence<'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 Sequence<'a>

§

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

Formats the value using the given formatter. Read more
§

impl<'a> PartialEq for Sequence<'a>

§

fn eq(&self, other: &Sequence<'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> Tagged for Sequence<'a>

§

const TAG: Tag = Tag::Sequence

§

impl ToDer for Sequence<'_>

§

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

Get the length of the object, when encoded
§

fn write_der_header( &self, writer: &mut dyn Write ) -> Result<usize, SerializeError>

Attempt to write the DER header to this writer.
§

fn write_der_content( &self, writer: &mut dyn Write ) -> Result<usize, SerializeError>

Attempt to write the DER content (all except header) to this writer.
§

fn to_der_vec(&self) -> Result<Vec<u8>, SerializeError>

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

fn to_der_vec_raw(&self) -> Result<Vec<u8>, SerializeError>

Similar to using to_vec, but uses provided values without changes. This can generate an invalid encoding for a DER object.
§

fn write_der(&self, writer: &mut dyn Write) -> Result<usize, SerializeError>

Attempt to write the DER encoded representation (header and content) into this writer. Read more
§

fn write_der_raw(&self, writer: &mut dyn Write) -> Result<usize, SerializeError>

Similar to using to_der, but uses provided values without changes. This can generate an invalid encoding for a DER object.
§

impl<'a> ToStatic for Sequence<'a>

§

type Owned = Sequence<'static>

§

fn to_static(&self) -> <Sequence<'a> as ToStatic>::Owned

§

impl<'a> TryFrom<Any<'a>> for Sequence<'a>

§

type Error = Error

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

fn try_from(any: Any<'a>) -> Result<Sequence<'a>, Error>

Performs the conversion.
§

impl<'a> Eq for Sequence<'a>

§

impl<'a> StructuralEq for Sequence<'a>

§

impl<'a> StructuralPartialEq for Sequence<'a>

Auto Trait Implementations§

§

impl<'a> RefUnwindSafe for Sequence<'a>

§

impl<'a> Send for Sequence<'a>

§

impl<'a> Sync for Sequence<'a>

§

impl<'a> Unpin for Sequence<'a>

§

impl<'a> UnwindSafe for Sequence<'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
§

impl<'a, T> AsTaggedExplicit<'a> for Twhere T: 'a,

§

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

§

impl<'a, T> AsTaggedImplicit<'a> for Twhere T: 'a,

§

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

source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
§

impl<T> Choice for Twhere T: Tagged,

§

fn can_decode(tag: Tag) -> bool

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

impl<T> DynTagged for Twhere T: Tagged,

§

fn tag(&self) -> Tag

§

impl<Q, K> Equivalent<K> for Qwhere Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
§

impl<Q, K> Equivalent<K> for Qwhere Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<'a, T> FromBer<'a> for Twhere T: TryFrom<Any<'a>, Error = Error>,

§

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

Attempt to parse input bytes into a BER object
§

impl<'a, T> FromDer<'a> for Twhere T: TryFrom<Any<'a>, Error = Error> + CheckDerConstraints,

§

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

Attempt to parse input bytes into a DER object (enforcing constraints)
§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

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

§

impl<T> IntoCollection<T> for T

§

fn into_collection<A>(self) -> SmallVec<A> where A: Array<Item = T>,

Converts self into a collection.
§

fn mapped<U, F, A>(self, f: F) -> SmallVec<A> where F: FnMut(T) -> U, A: Array<Item = U>,

source§

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

source§

fn fg(&self, value: Color) -> Painted<&T>

Returns a styled value derived from self with the foreground set to value.

This method should be used rarely. Instead, prefer to use color-specific builder methods like red() and green(), which have the same functionality but are pithier.

Example

Set foreground color to white using fg():

use yansi::{Paint, Color};

painted.fg(Color::White);

Set foreground color to white using white().

use yansi::Paint;

painted.white();
source§

fn primary(&self) -> Painted<&T>

Returns self with the fg() set to Color::Primary.

Example
println!("{}", value.primary());
source§

fn fixed(&self, color: u8) -> Painted<&T>

Returns self with the fg() set to Color::Fixed.

Example
println!("{}", value.fixed(color));
source§

fn rgb(&self, r: u8, g: u8, b: u8) -> Painted<&T>

Returns self with the fg() set to Color::Rgb.

Example
println!("{}", value.rgb(r, g, b));
source§

fn black(&self) -> Painted<&T>

Returns self with the fg() set to Color::Black.

Example
println!("{}", value.black());
source§

fn red(&self) -> Painted<&T>

Returns self with the fg() set to Color::Red.

Example
println!("{}", value.red());
source§

fn green(&self) -> Painted<&T>

Returns self with the fg() set to Color::Green.

Example
println!("{}", value.green());
source§

fn yellow(&self) -> Painted<&T>

Returns self with the fg() set to Color::Yellow.

Example
println!("{}", value.yellow());
source§

fn blue(&self) -> Painted<&T>

Returns self with the fg() set to Color::Blue.

Example
println!("{}", value.blue());
source§

fn magenta(&self) -> Painted<&T>

Returns self with the fg() set to Color::Magenta.

Example
println!("{}", value.magenta());
source§

fn cyan(&self) -> Painted<&T>

Returns self with the fg() set to Color::Cyan.

Example
println!("{}", value.cyan());
source§

fn white(&self) -> Painted<&T>

Returns self with the fg() set to Color::White.

Example
println!("{}", value.white());
source§

fn bright_black(&self) -> Painted<&T>

Returns self with the fg() set to Color::BrightBlack.

Example
println!("{}", value.bright_black());
source§

fn bright_red(&self) -> Painted<&T>

Returns self with the fg() set to Color::BrightRed.

Example
println!("{}", value.bright_red());
source§

fn bright_green(&self) -> Painted<&T>

Returns self with the fg() set to Color::BrightGreen.

Example
println!("{}", value.bright_green());
source§

fn bright_yellow(&self) -> Painted<&T>

Returns self with the fg() set to Color::BrightYellow.

Example
println!("{}", value.bright_yellow());
source§

fn bright_blue(&self) -> Painted<&T>

Returns self with the fg() set to Color::BrightBlue.

Example
println!("{}", value.bright_blue());
source§

fn bright_magenta(&self) -> Painted<&T>

Returns self with the fg() set to Color::BrightMagenta.

Example
println!("{}", value.bright_magenta());
source§

fn bright_cyan(&self) -> Painted<&T>

Returns self with the fg() set to Color::BrightCyan.

Example
println!("{}", value.bright_cyan());
source§

fn bright_white(&self) -> Painted<&T>

Returns self with the fg() set to Color::BrightWhite.

Example
println!("{}", value.bright_white());
source§

fn bg(&self, value: Color) -> Painted<&T>

Returns a styled value derived from self with the background set to value.

This method should be used rarely. Instead, prefer to use color-specific builder methods like on_red() and on_green(), which have the same functionality but are pithier.

Example

Set background color to red using fg():

use yansi::{Paint, Color};

painted.bg(Color::Red);

Set background color to red using on_red().

use yansi::Paint;

painted.on_red();
source§

fn on_primary(&self) -> Painted<&T>

Returns self with the bg() set to Color::Primary.

Example
println!("{}", value.on_primary());
source§

fn on_fixed(&self, color: u8) -> Painted<&T>

Returns self with the bg() set to Color::Fixed.

Example
println!("{}", value.on_fixed(color));
source§

fn on_rgb(&self, r: u8, g: u8, b: u8) -> Painted<&T>

Returns self with the bg() set to Color::Rgb.

Example
println!("{}", value.on_rgb(r, g, b));
source§

fn on_black(&self) -> Painted<&T>

Returns self with the bg() set to Color::Black.

Example
println!("{}", value.on_black());
source§

fn on_red(&self) -> Painted<&T>

Returns self with the bg() set to Color::Red.

Example
println!("{}", value.on_red());
source§

fn on_green(&self) -> Painted<&T>

Returns self with the bg() set to Color::Green.

Example
println!("{}", value.on_green());
source§

fn on_yellow(&self) -> Painted<&T>

Returns self with the bg() set to Color::Yellow.

Example
println!("{}", value.on_yellow());
source§

fn on_blue(&self) -> Painted<&T>

Returns self with the bg() set to Color::Blue.

Example
println!("{}", value.on_blue());
source§

fn on_magenta(&self) -> Painted<&T>

Returns self with the bg() set to Color::Magenta.

Example
println!("{}", value.on_magenta());
source§

fn on_cyan(&self) -> Painted<&T>

Returns self with the bg() set to Color::Cyan.

Example
println!("{}", value.on_cyan());
source§

fn on_white(&self) -> Painted<&T>

Returns self with the bg() set to Color::White.

Example
println!("{}", value.on_white());
source§

fn on_bright_black(&self) -> Painted<&T>

Returns self with the bg() set to Color::BrightBlack.

Example
println!("{}", value.on_bright_black());
source§

fn on_bright_red(&self) -> Painted<&T>

Returns self with the bg() set to Color::BrightRed.

Example
println!("{}", value.on_bright_red());
source§

fn on_bright_green(&self) -> Painted<&T>

Returns self with the bg() set to Color::BrightGreen.

Example
println!("{}", value.on_bright_green());
source§

fn on_bright_yellow(&self) -> Painted<&T>

Returns self with the bg() set to Color::BrightYellow.

Example
println!("{}", value.on_bright_yellow());
source§

fn on_bright_blue(&self) -> Painted<&T>

Returns self with the bg() set to Color::BrightBlue.

Example
println!("{}", value.on_bright_blue());
source§

fn on_bright_magenta(&self) -> Painted<&T>

Returns self with the bg() set to Color::BrightMagenta.

Example
println!("{}", value.on_bright_magenta());
source§

fn on_bright_cyan(&self) -> Painted<&T>

Returns self with the bg() set to Color::BrightCyan.

Example
println!("{}", value.on_bright_cyan());
source§

fn on_bright_white(&self) -> Painted<&T>

Returns self with the bg() set to Color::BrightWhite.

Example
println!("{}", value.on_bright_white());
source§

fn attr(&self, value: Attribute) -> Painted<&T>

Enables the styling Attribute value.

This method should be used rarely. Instead, prefer to use attribute-specific builder methods like bold() and underline(), which have the same functionality but are pithier.

Example

Make text bold using attr():

use yansi::{Paint, Attribute};

painted.attr(Attribute::Bold);

Make text bold using using bold().

use yansi::Paint;

painted.bold();
source§

fn bold(&self) -> Painted<&T>

Returns self with the attr() set to Attribute::Bold.

Example
println!("{}", value.bold());
source§

fn dim(&self) -> Painted<&T>

Returns self with the attr() set to Attribute::Dim.

Example
println!("{}", value.dim());
source§

fn italic(&self) -> Painted<&T>

Returns self with the attr() set to Attribute::Italic.

Example
println!("{}", value.italic());
source§

fn underline(&self) -> Painted<&T>

Returns self with the attr() set to Attribute::Underline.

Example
println!("{}", value.underline());

Returns self with the attr() set to Attribute::Blink.

Example
println!("{}", value.blink());

Returns self with the attr() set to Attribute::RapidBlink.

Example
println!("{}", value.rapid_blink());
source§

fn invert(&self) -> Painted<&T>

Returns self with the attr() set to Attribute::Invert.

Example
println!("{}", value.invert());
source§

fn conceal(&self) -> Painted<&T>

Returns self with the attr() set to Attribute::Conceal.

Example
println!("{}", value.conceal());
source§

fn strike(&self) -> Painted<&T>

Returns self with the attr() set to Attribute::Strike.

Example
println!("{}", value.strike());
source§

fn quirk(&self, value: Quirk) -> Painted<&T>

Enables the yansi Quirk value.

This method should be used rarely. Instead, prefer to use quirk-specific builder methods like mask() and wrap(), which have the same functionality but are pithier.

Example

Enable wrapping using .quirk():

use yansi::{Paint, Quirk};

painted.quirk(Quirk::Wrap);

Enable wrapping using wrap().

use yansi::Paint;

painted.wrap();
source§

fn mask(&self) -> Painted<&T>

Returns self with the quirk() set to Quirk::Mask.

Example
println!("{}", value.mask());
source§

fn wrap(&self) -> Painted<&T>

Returns self with the quirk() set to Quirk::Wrap.

Example
println!("{}", value.wrap());
source§

fn linger(&self) -> Painted<&T>

Returns self with the quirk() set to Quirk::Linger.

Example
println!("{}", value.linger());
source§

fn clear(&self) -> Painted<&T>

Returns self with the quirk() set to Quirk::Clear.

Example
println!("{}", value.clear());
source§

fn bright(&self) -> Painted<&T>

Returns self with the quirk() set to Quirk::Bright.

Example
println!("{}", value.bright());
source§

fn on_bright(&self) -> Painted<&T>

Returns self with the quirk() set to Quirk::OnBright.

Example
println!("{}", value.on_bright());
source§

fn whenever(&self, value: Condition) -> Painted<&T>

Conditionally enable styling based on whether the Condition value applies. Replaces any previous condition.

See the crate level docs for more details.

Example

Enable styling painted only when both stdout and stderr are TTYs:

use yansi::{Paint, Condition};

painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);
source§

fn new(self) -> Painted<Self>where Self: Sized,

Create a new Painted with a default Style. Read more
source§

fn paint<S>(&self, style: S) -> Painted<&Self>where S: Into<Style>,

Apply a style wholesale to self. Any previous style is replaced. Read more
source§

impl<T> Same 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.
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.
source§

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

Performs the conversion.
§

impl<V, T> VZip<V> for Twhere V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more