Enum GenIdx

pub(crate) enum GenIdx {
    Weak(WeakIdx),
    Strong(StrongIdx),
}

A generational index for ObjMap.

Variants

Weak(WeakIdx)

An index into the arena of weak references.

Strong(StrongIdx)

An index into the arena of strong references

Implementations

impl GenIdx

Encoding functions for GenIdx.

The encoding is deliberately nondeterministic: we want to avoid situations where applications depend on the details of our ObjectIds, or hardcode the ObjectIds they expect, or rely on the same weak generational index getting encoded the same way every time they see it.

The encoding is deliberately non-cryptographic: we do not want to imply that this gives any security. It is just a mild deterrent to misuse.

If you find yourself wanting to reverse-engineer this code so that you can analyze these object IDs, please contact the Arti developers instead and let us give you a better way to do whatever you want.

pub(crate) const BYTE_LEN: usize = 16usize

The length of a byte-encoded (but not base-64 encoded) GenIdx.

pub(crate) fn is_strong(&self) -> bool

Return true if this is a strong (owning) reference.

pub(crate) fn encode(self) -> ObjectId

Encode self into an rpc::ObjectId that we can give to a client.

fn encode_with_rng<R: RngCore>(self, rng: &mut R) -> ObjectId

As encode, but take a Rng as an argument. For testing.

pub(crate) fn to_bytes<R: RngCore>(self, rng: &mut R) -> [u8; 16]

As encode_with_rng, but return an array of bytes.

pub(crate) fn try_decode(id: &ObjectId) -> Result<Self, LookupError>

Attempt to decode id into a GenIdx than an ObjMap can use.

pub(crate) fn from_bytes(bytes: &[u8]) -> Option<Self>

As try_decode, but take a slice of bytes.

Trait Implementations

impl Clone for GenIdx

fn clone(&self) -> GenIdx

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GenIdx

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

Formats the value using the given formatter.

impl PartialEq for GenIdx

fn eq(&self, other: &GenIdx) -> 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 Copy for GenIdx

impl Eq for GenIdx

impl StructuralPartialEq for GenIdx