Struct bsn1::BerRef

pub struct BerRef { /* private fields */ }

BerRef is a wrapper of [u8] and represents a BER.

This struct is ‘Unsized’, and user usually uses a reference to the instance.

Implementations

impl BerRef

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

Parses bytes starting with octets of ‘ASN.1 BER’ and returns a reference to BerRef .

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

This function is same to <&BerRef>::try_from .

Warnings

ASN.1 reserves some universal identifier numbers and they should not be used, however, this function ignores that. For example, number 15 (0x0f) is reserved for now, but this functions returns Ok.

Examples

use bsn1::BerRef;

// Represents 'True' as Boolean.
let bytes: &[u8] = &[0x01, 0x01, 0xff];
let ber0 = BerRef::from_bytes(bytes).unwrap();
assert!(ber0.contents().to_bool_ber().unwrap());

// The extra octets at the end does not affect to the result.
let bytes: &[u8] = &[0x01, 0x01, 0xff, 0x00];
let ber1 = BerRef::from_bytes(bytes).unwrap();
assert_eq!(ber0, ber1);

pub unsafe fn from_bytes_unchecked(bytes: &[u8]) -> &Self

Provides a reference from bytes without any check.

bytes must be BER octets and must not include any extra octet.

If it is not sure whether bytes are valid octets as an ‘BER’ or not, use TryFrom implementation or from_bytes.

Safety

The behavior is undefined if bytes is not formatted as a BER.

Examples

use bsn1::{BerRef, IdRef};

// Represents '0x34' as an Integer.
let bytes: &[u8] = &[0x02, 0x01, 0x34];
let ber = unsafe { BerRef::from_bytes_unchecked(bytes) };

assert_eq!(ber.id(), IdRef::integer());
assert_eq!(ber.contents().to_integer::<i32>().unwrap(), 0x34);

impl BerRef

pub fn id(&self) -> &IdRef

Provides a reference to IdRef of self .

Examples

use bsn1::{BerRef, IdRef};

// Represents '3' as an Integer.
let bytes: &[u8] = &[0x02, 0x01, 0x03];
let ber = BerRef::from_bytes(bytes).unwrap();

assert_eq!(ber.id(), IdRef::integer());

pub fn length(&self) -> Length

Returns Length of self.

Warnings

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

Examples

use bsn1::{BerRef, Length};

// Represents 'False' as a Boolean.
let bytes: &[u8] = &[0x01, 0x01, 0x00];
let ber = BerRef::from_bytes(bytes).unwrap();

assert_eq!(ber.length(), Length::Definite(1));

pub fn contents(&self) -> &ContentsRef

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

Examples

use bsn1::BerRef;

// Represents 'False' as a Boolean.
let bytes: &[u8] = &[0x01, 0x01, 0x00];
let ber = BerRef::from_bytes(bytes).unwrap();

assert_eq!(ber.contents().to_bool_ber().unwrap(), false);

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

Provides a reference to the inner slice.

Examples

use bsn1::BerRef;

// This octets represents '3' as an integer.
let bytes = vec![0x02, 0x01, 0x03];

let ber = unsafe { BerRef::from_bytes_unchecked(&bytes) };
assert_eq!(&bytes, ber.as_bytes());

Trait Implementations

impl AsRef<[u8]> for BerRef

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

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

impl Borrow<[u8]> for BerRef

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 Debug for BerRef

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

Formats the value using the given formatter.

impl<'a> From<&'a DerRef> for &'a BerRef

fn from(der: &'a DerRef) -> Self

Converts to this type from the input type.

impl From<&BerRef> for Ber

fn from(ber_ref: &BerRef) -> Self

Converts to this type from the input type.

impl Hash for BerRef

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

impl PartialEq<Ber> for BerRef

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: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<BerRef> for Ber

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

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

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 PartialEq<BerRef> for BerRef

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

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

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 ToOwned for BerRef

type Owned = Ber

The resulting type after obtaining ownership.

fn to_owned(&self) -> Self::Owned

Creates owned data from borrowed data, usually by cloning.

fn clone_into(&self, target: &mut Self::Owned)

Uses borrowed data to replace owned data, usually by cloning.

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

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

Parses bytes starting with octets of ‘ASN.1 BER’ and returns a reference to BerRef.

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

This function is same to BerRef::from_bytes.

Warnings

ASN.1 reserves some universal identifier numbers and they should not be used, however, this function ignores that. For example, number 15 (0x0f) is reserved for now, but this functions returns Ok.

type Error = Error

The type returned in the event of a conversion error.

impl Eq for BerRef

impl StructuralEq for BerRef

impl StructuralPartialEq for BerRef