Struct bcder::string::OctetString
source · pub struct OctetString(_);
Expand description
An octet string value.
An octet string is a sequence of octets, i.e., a glorified [u8]
. Basic
Encoding Rules, however, allow this sequence to be broken up into chunks
that are encoded separatedly to allow for very large octet strings and
cases where one doesn’t yet know the length of the string.
In order to avoid unnecessary allocations, this type wraps the raw content
octets of a BER encoded octet string. As a consequence, assembling the
complete string may actually be costly and should only be done if really
necessary. As an alternative, there is an iterator over the parts via the
iter
method or the IntoIterator
trait as well as an iterator over the
individual octets via the octets
method.
Octet strings are sometimes used to store BER encoded data. The
OctetStringSource
type, accessible via the to_source
method, provides
an implementation of the Source
trait to run a decoder on.
BER Encoding
Octet strings are either encoded as a primitive or a constructed value. In the primitive form, the content octets are the string’s octets. In a constructed form, the content is a sequence of encoded octets strings which in turn may be primitive or constructed. In this case, the string’s octets are the concatenation of all the content octets of the primitive forms in the order as encountered.
In CER, the string must use the primitive form if it is less than 1000 octets long and the constructed form otherwise. The constructed form must consists of a sequence of primitive values each exactly with a 1000 octets of content except for the last one.
In DER, only the primitive form is allowed.
Implementations§
source§impl OctetString
impl OctetString
sourcepub fn iter(&self) -> OctetStringIter<'_> ⓘ
pub fn iter(&self) -> OctetStringIter<'_> ⓘ
Returns an iterator over the parts of the octet string.
The iterator will produce &[u8]
which, when appended produce the
complete content of the octet string.
sourcepub fn octets(&self) -> OctetStringOctets<'_> ⓘ
pub fn octets(&self) -> OctetStringOctets<'_> ⓘ
Returns an iterator over the individual octets of the string.
sourcepub fn as_slice(&self) -> Option<&[u8]>
pub fn as_slice(&self) -> Option<&[u8]>
Returns a reference to the complete content if possible.
The method will return a bytes slice of the content if the octet
string was encoded as a single primitive value or None
otherwise.
This is guaranteed to return some slice if the value was produced by decoding in DER mode.
sourcepub fn to_bytes(&self) -> Bytes
pub fn to_bytes(&self) -> Bytes
Produces a bytes value with the string’s content.
If the octet string was encoded as a single primitive value, the method will simply clone the contnent. Otherwise it will produce an entirely new bytes value from the concatenated content of all the primitive values.
sourcepub fn len(&self) -> usize
pub fn len(&self) -> usize
Returns the length of the content.
This is not the length of the encoded value but of the actual octet string.
sourcepub fn to_source(&self) -> OctetStringSource
pub fn to_source(&self) -> OctetStringSource
Creates a source that can be used to decode the string’s content.
The returned value contains a clone of the string (which, because of
the use of Bytes
is rather cheap) that implements the Source
trait and thus can be used to decode the string’s content.
source§impl OctetString
impl OctetString
sourcepub fn take_from<S: Source>(
cons: &mut Constructed<'_, S>
) -> Result<Self, S::Err>
pub fn take_from<S: Source>(
cons: &mut Constructed<'_, S>
) -> Result<Self, S::Err>
Takes a single octet string value from constructed value content.
If there is no next value, if the next value does not have the tag
Tag::OCTET_STRING
, or if it doesn’t contain a correctly encoded
octet string, a malformed error is returned.
sourcepub fn from_content<S: Source>(
content: &mut Content<'_, S>
) -> Result<Self, S::Err>
pub fn from_content<S: Source>(
content: &mut Content<'_, S>
) -> Result<Self, S::Err>
Takes an octet string value from content.
sourcepub fn encode<'a>(&'a self) -> impl Values + 'a
pub fn encode<'a>(&'a self) -> impl Values + 'a
Returns a value encoder for the octet string using the natural tag.
sourcepub fn encode_as<'a>(&'a self, tag: Tag) -> impl Values + 'a
pub fn encode_as<'a>(&'a self, tag: Tag) -> impl Values + 'a
Returns a value encoder for the octet string using the given tag.
sourcepub fn encode_wrapped<V: Values>(mode: Mode, values: V) -> impl Values
pub fn encode_wrapped<V: Values>(mode: Mode, values: V) -> impl Values
Returns a value encoder that wraps values into an octet string.
This function allows an octet string wrapping some values to be created without having to first create the octet string.
Trait Implementations§
source§impl<L: CharSet> AsRef<OctetString> for RestrictedString<L>
impl<L: CharSet> AsRef<OctetString> for RestrictedString<L>
source§fn as_ref(&self) -> &OctetString
fn as_ref(&self) -> &OctetString
source§impl Clone for OctetString
impl Clone for OctetString
source§fn clone(&self) -> OctetString
fn clone(&self) -> OctetString
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for OctetString
impl Debug for OctetString
source§impl Hash for OctetString
impl Hash for OctetString
source§impl<'a> IntoIterator for &'a OctetString
impl<'a> IntoIterator for &'a OctetString
source§impl Ord for OctetString
impl Ord for OctetString
source§impl PartialEq<OctetString> for OctetString
impl PartialEq<OctetString> for OctetString
source§fn eq(&self, other: &OctetString) -> bool
fn eq(&self, other: &OctetString) -> bool
source§impl PartialOrd<OctetString> for OctetString
impl PartialOrd<OctetString> for OctetString
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresource§impl<T: AsRef<[u8]>> PartialOrd<T> for OctetString
impl<T: AsRef<[u8]>> PartialOrd<T> for OctetString
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read more