Struct BmpString 

pub struct BmpString(/* private fields */);

Available on crate feature crypto only.

ASN.1 BMPString type.

Examples

You can create a BmpString from a literal string with BmpString::try_from:

use rcgen::string::BmpString;
let hello = BmpString::try_from("hello").unwrap();

Supported characters

Encodes Basic Multilingual Plane (BMP) subset of Unicode (ISO 10646), a.k.a. UCS-2.

Bytes are encoded as UTF-16 big-endian.

BMPString is included for backward compatibility, RFC 5280 say it SHOULD NOT be used for certificates for new subjects.

Implementations

impl BmpString

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

Available on (crate features rustls or boring or acme) and crate feature rustls only.

Returns a byte slice of this BmpString’s contents.

The inverse of this method is from_utf16be.

Examples

use rcgen::string::BmpString;
let s = BmpString::try_from("hello").unwrap();

assert_eq!(&[0, 104, 0, 101, 0, 108, 0, 108, 0, 111], s.as_bytes());

pub fn from_utf16be(vec: Vec<u8>) -> Result<BmpString, Error>

Available on (crate features rustls or boring or acme) and crate feature rustls only.

Decode a UTF-16BE–encoded vector vec into a BmpString, returning Err if vec contains any invalid data.

Trait Implementations

impl Clone for BmpString

fn clone(&self) -> BmpString

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BmpString

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

Formats the value using the given formatter.

impl FromStr for BmpString

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<BmpString, <BmpString as FromStr>::Err>

Parses a string s to return a value of this type.

impl Hash for BmpString

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

where __H: Hasher,

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for BmpString

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl TryFrom<&str> for BmpString

fn try_from( value: &str, ) -> Result<BmpString, <BmpString as TryFrom<&str>>::Error>

Converts a &str to a BmpString.

Any character not in the BmpString charset will be rejected. See BmpString documentation for more information.

The result is allocated on the heap.

type Error = Error

The type returned in the event of a conversion error.

impl TryFrom<String> for BmpString

fn try_from( value: String, ) -> Result<BmpString, <BmpString as TryFrom<String>>::Error>

Converts a String into a BmpString

Any character not in the BmpString charset will be rejected. See BmpString documentation for more information.

Parsing a BmpString allocates memory since the UTF-8 to UTF-16 conversion requires a memory allocation.

type Error = Error

The type returned in the event of a conversion error.

impl Eq for BmpString

impl StructuralPartialEq for BmpString