Struct bsn1::Ber

pub struct Ber { /* fields omitted */ }

Ber owns BerRef and represents a BER.

Implementations

impl Ber

pub fn new(id: &IdRef, contents: &[u8]) -> Self

Creates a new instance from id and contents with definite length.

Note that BER allows both definite and indefinite length, however, the length of the return value is always definite. (Generally speaking, the performance of definite length is better than that of indefinite length. Indefinite length is seldom used these days.)

Examples

use bsn1::{Ber, IdRef};

let id = IdRef::octet_string();
let _ber = Ber::new(id, &[]);

pub fn from_id_iterator<I>(id: &IdRef, contents: I) -> Self where
    I: Iterator + Clone,
    I::Item: AsRef<[u8]>, 

Creates a new instance from id and contents .

Examples

use bsn1::{Ber, IdRef};

let id = IdRef::sequence();

// Build instance using function 'from_id_iterator()'.
let contents: &[Ber] = &[Ber::utf8_string("foo"), Ber::integer(29)];
let ber = Ber::from_id_iterator(id, contents.iter());

// Build instance using function 'new()'.
let contents: Vec<u8> = contents.iter()
                        .map(|i| Vec::from(i.as_ref() as &[u8]))
                        .flatten().collect();
let expected = Ber::new(id, &contents);

assert_eq!(expected, ber);

pub fn boolean(val: bool) -> Self

Returns a new instance representing boolean.

Examples

use bsn1::{contents, Ber, IdRef};

let val = true;
let ber = Ber::boolean(val);

assert_eq!(IdRef::boolean(), ber.id());
assert_eq!(val, contents::to_bool_ber(ber.contents()).unwrap());

pub fn integer(val: i128) -> Self

Returns a new instance representing ingeger.

Examples

use bsn1::{contents, Ber, IdRef};

let val = 39;
let ber = Ber::integer(val);

assert_eq!(IdRef::integer(), ber.id());
assert_eq!(val, contents::to_integer(ber.contents()).unwrap());

pub fn utf8_string(val: &str) -> Self

Returns a new instance representing utf8_string.

Examples

use bsn1::{Ber, IdRef};

let val = &"foo";
let ber = Ber::utf8_string(val);

assert_eq!(IdRef::utf8_string(), ber.id());
assert_eq!(val.as_bytes(), ber.contents());

pub fn octet_string(val: &[u8]) -> Self

Returns a new instance representing octet_string.

Examples

use bsn1::{Ber, IdRef};

let val = &[1, 2, 3];
let ber = Ber::octet_string(val);

assert_eq!(IdRef::octet_string(), ber.id());
assert_eq!(val, ber.contents());

impl Ber

pub fn into_vec(self) -> Vec<u8>

Consumes self , returning Vec .

Examples

use bsn1::{Ber, IdRef};

let id = IdRef::octet_string();
let contents: &[u8] = &[0, 1, 2, 3, 4];

let ber = Ber::new(id, contents);
let v = ber.clone().into_vec();

assert_eq!(ber.as_ref() as &[u8], v.as_ref() as &[u8]);

Methods from Deref<Target = BerRef>

pub fn id(&self) -> &IdRef

Provides a reference to IdRef of self .

Examples

use bsn1::{Ber, BerRef, IdRef};

let id = IdRef::octet_string();
let contents = &[1, 2, 3];

// 'Ber' implements 'Deref<Target=BerRef>.'
let ber = Ber::new(id, contents);
assert_eq!(id, ber.id());

pub fn length(&self) -> Length

Returns Length of self .

Warnings

Length stands for ‘the length octets of the contents’ in BER. The total bytes is greater than the value.

Examples

use bsn1::{Ber, BerRef, IdRef, Length};

let id = IdRef::octet_string();
let contents = &[1, 2, 3];

// 'Ber' implements 'Deref<Target=BerRef>.'
let ber = Ber::new(id, contents);
assert_eq!(Length::Definite(contents.len()), ber.length());

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

Provides a reference to the ‘contents’ octets of self .

Examples

use bsn1::{Ber, BerRef, IdRef};

let id = IdRef::octet_string();
let contents = &[1, 2, 3];

// 'Ber' implements 'Deref<Target=BerRef>.'
let ber = Ber::new(id, contents);
assert_eq!(contents, ber.contents());

Trait Implementations

impl AsRef<[u8]> for Ber

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

Performs the conversion.

impl AsRef<BerRef> for Ber

fn as_ref(&self) -> &BerRef

Performs the conversion.

impl Borrow<[u8]> for Ber

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

Immutably borrows from an owned value.

impl Borrow<BerRef> for Ber

fn borrow(&self) -> &BerRef

Immutably borrows from an owned value.

impl Clone for Ber

fn clone(&self) -> Ber

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Ber

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

Formats the value using the given formatter.

impl Deref for Ber

type Target = BerRef

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Eq for Ber

impl From<&'_ BerRef> for Ber

fn from(ber_ref: &BerRef) -> Self

Performs the conversion.

impl From<&'_ DerRef> for Ber

fn from(der: &DerRef) -> Self

Performs the conversion.

impl From<Der> for Ber

fn from(der: Der) -> Self

Performs the conversion.

impl PartialEq<Ber> for Ber

fn eq(&self, other: &Ber) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralEq for Ber

impl StructuralPartialEq for Ber

impl TryFrom<&'_ [u8]> for Ber

type Error = Error

The type returned in the event of a conversion error.

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

Parses bytes starting with octets of ‘ASN.1 BER’ and returns a new instance.

This function ignores extra octet(s) at the end of bytes if any.