Struct bsn1::Id

pub struct Id { /* fields omitted */ }

Id owns IdRef and represents Identifier.

Note that this struct may allocate heap memory if the number is very large, because ASN.1 does not limit the length of identifier bytes, however, it uses only stack memory at least the number equals to or is less than usize::MAX .

Implementations

impl Id

pub fn new(class: ClassTag, pc: PCTag, number: u128) -> Self

Creates a new instance from class , pc , and number .

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 so far, but this function accepts such a number.

Examples

use bsn1::{ClassTag, Id, PCTag};

// Creates 'Universal Integer'
let _id = Id::new(ClassTag::Universal, PCTag::Primitive, 2);

Methods from Deref<Target = IdRef>

pub fn class(&self) -> ClassTag

Returns ClassTag of self .

Examples

use bsn1::{ClassTag, Id, PCTag};

// 'Id' implements 'Deref<Target = IdRef>'.
let id = Id::new(ClassTag::Universal, PCTag::Primitive, 0);
assert_eq!(ClassTag::Universal, id.class());

let id = Id::new(ClassTag::Application, PCTag::Constructed, 1);
assert_eq!(ClassTag::Application, id.class());

let id = Id::new(ClassTag::ContextSpecific, PCTag::Primitive, 2);
assert_eq!(ClassTag::ContextSpecific, id.class());

let id = Id::new(ClassTag::Private, PCTag::Constructed, 3);
assert_eq!(ClassTag::Private, id.class());

pub fn is_universal(&self) -> bool

Returns true if self is 'Universal' class, or false .

Examples

use bsn1::{ClassTag, Id, PCTag};

// 'Id' implements 'Deref<Target = IdRef>'.
let id = Id::new(ClassTag::Universal, PCTag::Primitive, 0);
assert_eq!(true, id.is_universal());

pub fn is_application(&self) -> bool

Returns true if self is 'Application' class, or false .

Examples

use bsn1::{ClassTag, Id, PCTag};

// 'Id' implements 'Deref<Target = IdRef>'.
let id = Id::new(ClassTag::Application, PCTag::Primitive, 0);
assert_eq!(true, id.is_application());

pub fn is_context_specific(&self) -> bool

Returns true if self is 'Context Specific' class, or false .

Examples

use bsn1::{ClassTag, Id, PCTag};

// 'Id' implements 'Deref<Target = IdRef>'.
let id = Id::new(ClassTag::ContextSpecific, PCTag::Primitive, 0);
assert_eq!(true, id.is_context_specific());

pub fn is_private(&self) -> bool

Returns true if self is 'Private' class, or false .

Examples

use bsn1::{ClassTag, Id, PCTag};

// 'Id' implements 'Deref<Target = IdRef>'.
let id = Id::new(ClassTag::Private, PCTag::Primitive, 0);
assert_eq!(true, id.is_private());

pub fn pc(&self) -> PCTag

Returns the Primitive/Constructed flag of self .

Examples

use bsn1::{ClassTag, Id, PCTag};

// 'Id' implements 'Deref<Target = IdRef>'.
let id = Id::new(ClassTag::Universal, PCTag::Primitive, 0);
assert_eq!(PCTag::Primitive, id.pc());

let id = Id::new(ClassTag::Application, PCTag::Constructed, 1);
assert_eq!(PCTag::Constructed, id.pc());

pub fn is_primitive(&self) -> bool

Returns true if self is flagged as 'Primitive', or false .

Examples

use bsn1::{ClassTag, Id, PCTag};

// 'Id' implements 'Deref<Target = IdRef>'.
let id = Id::new(ClassTag::Universal, PCTag::Primitive, 0);
assert_eq!(true, id.is_primitive());

pub fn is_constructed(&self) -> bool

Returns true if self is flagged as 'Constructed', or false .

Examples

use bsn1::{ClassTag, Id, PCTag};

// 'Id' implements 'Deref<Target = IdRef>'.
let id = Id::new(ClassTag::Universal, PCTag::Constructed, 0);
assert_eq!(true, id.is_constructed());

pub fn number(&self) -> Result<u128, Error>

Returns the number of self unless overflow.

Examples

use bsn1::{ClassTag, Id, PCTag};

// 'Id' implements 'Deref<Target = IdRef>'.
let id = Id::new(ClassTag::Application, PCTag::Primitive, 49);
assert_eq!(49, id.number().unwrap());

Trait Implementations

impl AsRef<[u8]> for Id

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

Performs the conversion.

impl AsRef<IdRef> for Id

fn as_ref(&self) -> &IdRef

Performs the conversion.

impl Borrow<[u8]> for Id

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

Immutably borrows from an owned value.

impl Borrow<IdRef> for Id

fn borrow(&self) -> &IdRef

Immutably borrows from an owned value.

impl Clone for Id

fn clone(&self) -> Id

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Id

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

Formats the value using the given formatter.

impl Deref for Id

type Target = IdRef

The resulting type after dereferencing.

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

Dereferences the value.

impl Eq for Id

impl Hash for Id

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

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for Id

fn cmp(&self, other: &Id) -> Ordering

This method returns an Ordering between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<Id> for Id

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

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

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

This method tests for !=.

impl PartialOrd<Id> for Id

fn partial_cmp(&self, other: &Id) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Id) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Id) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Id) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Id) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for Id

impl StructuralPartialEq for Id

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

type Error = Error

The type returned in the event of a conversion error.

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

Parses bytes starts with identifier octets and tries to build a new instance.

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

Warnings

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 so far, but this functions returns Ok .