Asn Rust Reference Documentation
Asn
Current Version: 11.6.1
Chilkat.Asn
Load ASN.1 from binary DER bytes, encoded text such as Base64 or hex,
files, or existing
Read the item tag, tag value, constructed/primitive state, sub-item
count, string content, boolean value, or integer value.
Append constructed
Add booleans, integers, big integers, bit strings, octet strings, OIDs,
strings, times, null values, and encoded byte content.
Add context-specific primitive or constructed items when working with
ASN.1 formats that use tagged application-specific structures.
Convert ASN.1 to XML for inspection or editing, load ASN.1 back from XML,
and output the result as binary or encoded DER.
Load, inspect, build, edit, and encode ASN.1 structures in DER or XML form.
Chilkat.Asn represents an ASN.1 item and its optional child
items. It can load ASN.1 from binary DER, encoded DER strings, files, or
BinData; expose tags, tag values, primitive content, boolean
and integer values, and child counts; build constructed structures such as
SEQUENCE and SET; append common primitive types
such as booleans, integers, big integers, bit strings, octets, OIDs, strings,
times, null values, and context-specific items; convert ASN.1 to XML; reload
from that XML form; and write the final structure back to DER.
Load DER data
BinData objects.
Inspect ASN.1 items
Build sequences and sets
SEQUENCE and SET items,
then add child ASN.1 values beneath them.
Append primitive values
Context-specific tags
DER and XML conversion
LoadBinary, LoadEncoded,
LoadBd, or LoadBinaryFile, inspect the tree with
Tag, Constructed, NumSubItems, and
GetSubItem, then extract primitive content or convert to XML
with AsnToXml. To create ASN.1, start with a constructed item,
append child values, and write the final DER with GetBinaryDer,
GetEncodedDer, WriteBd, or
WriteBinaryDer.
Object Creation
// Cargo.toml:
// [dependencies]
// chilkat = "11.6"
use chilkat::Asn;
// Once per process, before any other Chilkat call:
chilkat::unlock_bundle("Anything for 30-day trial")?; // shorthand for Global::new().unlock_bundle(..)
let asn = Asn::new();
// ... the native object is freed when `asn` goes out of scope.Creates the underlying native Chilkat object (Asn also implements Default). Every method takes &self, so the object never needs to be declared mut. A Asn is Send but not Sync: it may be moved to another thread, but a reference to it cannot be shared between threads at the same time.
The native object is freed when the Asn is dropped — when it goes out of scope, or explicitly with drop(asn). There is no Dispose method to call.
Errors
Methods that can fail return chilkat::Result<T>, which is Result<T, chilkat::Error>: a method whose only outcome is success or failure returns Result<()>, a method producing a string or an object returns Result<String> or Result<Asn>. The error carries the object's LastErrorText at the time of the failure (Error::last_error_text), the class and method names, and implements std::error::Error, so ? works in any function returning chilkat::Result or a Box<dyn Error>. Properties never fail, and methods that answer a question (has_..., is_..., ...) return a plain bool.
match asn.some_method(...) {
Ok(value) => println!("{value:?}"),
Err(e) => eprintln!("{}", e.last_error_text()),
}Properties
BoolValue
pub fn bool_value(&self) -> bool
pub fn set_bool_value(&self, value: bool)
The ASN.1 item's boolean value if it is a boolean item.
topConstructed
pub fn constructed(&self) -> bool
true if this ASN.1 item is a constructed item. Sequence and Set items are constructed and can contain sub-items. All other tags (boolean, integer, octets, utf8String, etc.) are primitive (non-constructed).
ContentStr
The ASN.1 item's content if it is an ASN.1 string type (such as Utf8String, BmpString, PrintableString, VisibleString, T61String, IA5String, NumericString, or UniversalString).
topDebugLogFilePath
pub fn debug_log_file_path(&self) -> String
pub fn set_debug_log_file_path(&self, value: &str)
If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.
Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.
Possible causes of hangs include:
- A timeout property set to 0, indicating an infinite timeout.
- A hang occurring within an event callback in the application code.
- An internal bug in the Chilkat code causing the hang.
IntValue
pub fn int_value(&self) -> i32
pub fn set_int_value(&self, value: i32)
The ASN.1 item's integer value if it is a small integer item.
topLastErrorHtml
Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
topLastErrorText
Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
LastErrorXml
Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
topLastMethodSuccess
pub fn last_method_success(&self) -> bool
pub fn set_last_method_success(&self, value: bool)
Indicates the success or failure of the most recent method call: true means success, false means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages. Note: This property does not apply to methods that return integer values or to boolean-returning methods where the boolean does not indicate success or failure.
NumSubItems
pub fn num_sub_items(&self) -> i32
The number of sub-items contained within this ASN.1 item. Only constructed items, such as Sequence and Set will contain sub-iitems. Primitive items such as OIDs, octet strings, integers, etc. will never contain sub-items.
topTag
The ASN.1 item's tag as a descriptive string. Possible values are:
boolean integer bitString octets null oid utf8String relativeOid sequence set numericString printableString t61String ia5String utcTime bmpStringtop
TagValue
pub fn tag_value(&self) -> i32
The ASN.1 item's tag as a integer value. The integer values for possible tags are as follows:
boolean (1) integer (2) bitString (3) octets (4) null (5) oid (6) utf8String (12) relativeOid (13) sequence (16) set (17) numericString (18) printableString (19) t61String (20) ia5String (22) utcTime (23) bmpString (30)top
VerboseLogging
pub fn verbose_logging(&self) -> bool
pub fn set_verbose_logging(&self, value: bool)
If set to true, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is false. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.
Version
Methods
AppendBigInt
Appends an ASN.1 integer, but one that is a big (huge) integer that is too large to be represented by an integer variable. The bytes composing the integer are passed in encoded string format (such as base64, hex, etc.). The byte order must be big-endian. The encoding may be any of the following encodings: Base64, Hex, Base58, modBase64, Base32, UU, QP (for quoted-printable), URL (for url-encoding), Q, B, url_oath, url_rfc1738, url_rfc2396, and url_rfc3986. The encoding name is case insensitive (for example, both Base64 and base64 are treated the same).
Returns Ok(()) for success, Err(chilkat::Error) for failure.
AppendBits
Appends an ASN.1 bit string to the caller's sub-items. The bytes containing the bits are passed in encoded string format (such as base64, hex, etc.). The byte order must be big-endian (MSB first). The encoding may be any of the following encodings: Base64, Hex, Base58, modBase64, Base32, UU, QP (for quoted-printable), URL (for url-encoding), Q, B, url_oath, url_rfc1738, url_rfc2396, and url_rfc3986. The encoding name is case insensitive (for example, both Base64 and base64 are treated the same).
Returns Ok(()) for success, Err(chilkat::Error) for failure.
AppendBool
Appends an ASN.1 boolean item to the caller's sub-items. Items may only be appended to constructed data types such as Sequence and Set.
Returns Ok(()) for success, Err(chilkat::Error) for failure.
AppendContextConstructed
Appends an ASN.1 context-specific constructed item to the caller's sub-items.
Returns Ok(()) for success, Err(chilkat::Error) for failure.
AppendContextPrimitive
Appends an ASN.1 context-specific primitive item to the caller's sub-items. The bytes are passed in encoded string format (such as base64, hex, etc.). The encoding may be any of the following encodings: Base64, Hex, Base58, modBase64, Base32, UU, QP (for quoted-printable), URL (for url-encoding), Q, B, url_oath, url_rfc1738, url_rfc2396, and url_rfc3986. The encoding name is case insensitive (for example, both Base64 and base64 are treated the same).
Returns Ok(()) for success, Err(chilkat::Error) for failure.
AppendInt
Appends an ASN.1 integer item to the caller's sub-items. Items may only be appended to constructed data types such as Sequence and Set.
Returns Ok(()) for success, Err(chilkat::Error) for failure.
AppendNull
Appends an ASN.1 null item to the caller's sub-items. Items may only be appended to constructed data types such as Sequence and Set.
Returns Ok(()) for success, Err(chilkat::Error) for failure.
AppendOctets
Appends an ASN.1 octet string to the caller's sub-items. The bytes are passed in encoded string format (such as base64, hex, etc.). The encoding may be any of the following encodings: Base64, Hex, Base58, modBase64, Base32, UU, QP (for quoted-printable), URL (for url-encoding), Q, B, url_oath, url_rfc1738, url_rfc2396, and url_rfc3986. The encoding name is case insensitive (for example, both Base64 and base64 are treated the same).
Returns Ok(()) for success, Err(chilkat::Error) for failure.
AppendOid
Appends an ASN.1 OID (object identifier) to the caller's sub-items. The OID is passed in string form, such as 1.2.840.113549.1.9.1.
Returns Ok(()) for success, Err(chilkat::Error) for failure.
AppendSequence
Appends an ASN.1 sequence item to the caller's sub-items.
Returns Ok(()) for success, Err(chilkat::Error) for failure.
AppendSequence2
Appends an ASN.1 sequence item to the caller's sub-items, and updates the internal reference to point to the newly appended sequence item.
Returns Ok(()) for success, Err(chilkat::Error) for failure.
AppendSequenceR
Appends an ASN.1 sequence item to the caller's sub-items, and returns the newly appended sequence item.
Returns Err(chilkat::Error) on failure.
AppendSet
Appends an ASN.1 set item to the caller's sub-items.
Returns Ok(()) for success, Err(chilkat::Error) for failure.
AppendSet2
Appends an ASN.1 set item to the caller's sub-items, and updates the internal reference to point to the newly appended set item.
Returns Ok(()) for success, Err(chilkat::Error) for failure.
AppendSetR
Appends an ASN.1 set item to the caller's sub-items, and returns the newly appended set item.
Returns Err(chilkat::Error) on failure.
AppendString
Appends a string item to the caller's sub-items. The str_type specifies the type of string to be added. It may be utf8, ia5, t61, printable, visible, numeric, universal, or bmp. The value must conform to the ASN.1 restrictions imposed for a given string type. The utf8, bmp, and universal types have no restrictions on what characters are allowed. In general, unless a specific type of string is required, choose the utf8 type.
Returns Ok(()) for success, Err(chilkat::Error) for failure.
AppendTime
Appends a UTCTime item to the caller's sub-items. The time_format specifies the format of the date_time_str. It should be set to utc. (In the future, this method will be expanded to append GeneralizedTime items by using generalized for time_format.) To append the current date/time, set date_time_str equal to the empty string or the keyword now. Otherwise, the date_time_str should be in the UTC time format YYMMDDhhmm[ss]Z or YYMMDDhhmm[ss](+|-)hhmm.
Returns Ok(()) for success, Err(chilkat::Error) for failure.
AsnToXml
Converts ASN.1 to XML and returns the XML string.
Returns Err(chilkat::Error) on failure.
DeleteSubItem
Discards the Nth sub-item. (The 1st sub-item is at index 0.)
Returns Ok(()) for success, Err(chilkat::Error) for failure.
GetEncodedContent
Returns the content of the ASN.1 item in encoded string form. The encoding may be any of the following encodings: Base64, Hex, Base58, modBase64, Base32, UU, QP (for quoted-printable), URL (for url-encoding), Q, B, url_oath, url_rfc1738, url_rfc2396, and url_rfc3986. The encoding name is case insensitive (for example, both Base64 and base64 are treated the same).
Returns Err(chilkat::Error) on failure.
GetEncodedDer
Returns the binary DER in encoded string form. The encoding indicates the encoding and can be base64, hex, uu, quoted-printable, base32, or modbase64.
Returns Err(chilkat::Error) on failure.
GetLastSubItem
Returns the last ASN.1 sub-item. This method can be called immediately after any Append* method to access the appended item.
Returns Err(chilkat::Error) on failure.
GetSubItem
Returns the Nth ASN.1 sub-item. The 1st sub-item is at index 0.
Returns Err(chilkat::Error) on failure.
LoadAsnXml
Loads ASN.1 from the XML representation (such as that created by the AsnToXml method).
Returns Ok(()) for success, Err(chilkat::Error) for failure.
LoadBd
Loads ASN.1 from the binary DER contained in bd.
Returns Ok(()) for success, Err(chilkat::Error) for failure.
LoadBinaryFile
Loads ASN.1 from a binary DER file.
Returns Ok(()) for success, Err(chilkat::Error) for failure.
LoadEncoded
Loads ASN.1 from an encoded string. The encoding can be base64, hex, uu, quoted-printable, base32, or modbase64.
Returns Ok(()) for success, Err(chilkat::Error) for failure.
SetEncodedContent
Sets the content of this primitive ASN.1 item. The encoding may be any of the following encodings: Base64, Hex, Base58, modBase64, Base32, UU, QP (for quoted-printable), URL (for url-encoding), Q, B, url_oath, url_rfc1738, url_rfc2396, and url_rfc3986. The encoding name is case insensitive (for example, both Base64 and base64 are treated the same).
Returns Ok(()) for success, Err(chilkat::Error) for failure.
WriteBd
Appends the ASN.1 in binary DER format to bd.
Returns Ok(()) for success, Err(chilkat::Error) for failure.
WriteBinaryDer
Writes the ASN.1 in binary DER form to a file.
Returns Ok(()) for success, Err(chilkat::Error) for failure.