core/at.asitplus.awesn1/Asn1BitString

Asn1BitString

@Serializable(with = Asn1BitString.Companion::class)

class Asn1BitString : Asn1AbstractBitString(source)

A general ASN.1 BIT STRING. It has a concrete size (sizeBits/sizeBytes), and can be indexed accordingly.

Types

Companion

object Companion : Asn1Serializable<Asn1Primitive, Asn1BitString>

Properties

bitCarryingBytes

open override val bitCarryingBytes: ByteArray

A copy of the bytes containing the BitString. Within each byte, bit 0 is the most significant. This is normalized to comply with the type's canonical encoding (per DER), regardless of what the wire bytes were.

indices

val indices: LongRange

The available indices into the BIT STRING.

numPaddingBits

open override val numPaddingBits: Int

The number of trailing meaningless zero padding bits at the end of bitCarryingBytes. Always in 0..7.

sizeBits

val sizeBits: Long

The size of the BIT STRING in bits.

sizeBytes

val sizeBytes: Int

The size of the BIT STRING in bytes.

Functions

encodeToDer

fun Asn1Encodable<*>.encodeToDer(): ByteArray

Convenience function to directly get the DER-encoded representation of the implementing object

fun Asn1Encodable<*>.encodeToDer(sink: Sink)

encodeToDerOrNull

fun Asn1Encodable<*>.encodeToDerOrNull(): ByteArray?

Exception-free version of encodeToDer

encodeToTlv

open override fun encodeToTlv(): Asn1Primitive

Encodes the implementing object into an A

encodeToTlvOrNull

fun <A : Asn1Element> Asn1Encodable<A>.encodeToTlvOrNull(): A?

Exception-free version of Asn1Encodable.encodeToTlv

equals

open operator override fun equals(other: Any?): Boolean

get

open operator override fun get(bitIndex: Long): Boolean

Retrieves a single bit from the BIT STRING. Bits are addressed as per ASN.1, with index 0 being the most significant bit.

hashCode

open override fun hashCode(): Int

prettyPrintAsn1

open fun prettyPrintAsn1(): String

shorthand for Asn1Element.prettyPrint, hence, a call to this function encodes this encodable to an Asn1Element, holds it in memory, pretty prints it, and discards it. This characteristic may be relevant in memory-constrained environments.

toDerHexString

fun Asn1Encodable<*>.toDerHexString(lineLen: Int? = null): String

toString

open override fun toString(): String

withImplicitTag

open infix fun withImplicitTag(tag: Asn1Element.Tag): Asn1Element

Creates a new implicitly tagged ASN.1 Element from this ASN.1 Element. NOTE: The TagClass of the provided tag will be used! If you want the result to have TagClass.CONTEXT_SPECIFIC, also invoke tag withClass TagClass.CONTEXT_SPECIFIC!. If a CONSTRUCTED Tag is applied to an ASN.1 Primitive, the CONSTRUCTED bit is overridden and set to zero

open infix fun withImplicitTag(template: Asn1Element.Tag.Template): Asn1Element

Creates a new implicitly tagged ASN.1 Element from this ASN.1 Structure. If the provided template's tagClass is not set, the class of the resulting structure defaults to TagClass.CONTEXT_SPECIFIC. If a CONSTRUCTED Tag is applied to an ASN.1 Primitive, the CONSTRUCTED bit is overridden and set to zero

open infix fun withImplicitTag(tagValue: ULong): Asn1Element

Creates a new implicitly tagged ASN.1 Element from this ASN.1 Element. Sets the class of the resulting structure to TagClass.CONTEXT_SPECIFIC