Struct cipherstash_client::record::Record

pub struct Record {
    pub id: Uuid,
    pub fields: HashMap<String, Value>,
}

Fields

id: Uuid

fields: HashMap<String, Value>

Implementations

impl Record

pub fn get(&self, field: &str) -> Option<&Value>

pub async fn decrypt(
    cipher: &EnvelopeCipher<impl KeyProvider>,
    doc: Document
) -> Result<Self, RecordDecryptError>

Decrypt a record from an RPC Document

pub async fn encrypt(
    &self,
    cipher: &EnvelopeCipher<impl KeyProvider>
) -> Result<Document, RecordEncryptError>

Encrypt a record as an RPC Document

pub fn as_cbor_bytes(&self) -> Result<Vec<u8>, Error<Infallible>>

Losslessly encode a record as CBOR

When the record is encoded using this method it is safe to decode it using the try_from_cbor_bytes method. This means the bytes returned by this method can be encrypted and stored in the data service without needing to use the [RecordDecoder] upon retrieval.

pub fn try_from_cbor_bytes(id: Uuid, bytes: &[u8]) -> Result<Self, Error>

Load a record from CBOR without validating against a schema.

Note: this method should only be used when the CBOR bytes were encoded with the correct types. When CBOR is coming from an external source (such as JavaScript) the [RecordDecoder] should instead be used.

Trait Implementations

impl Debug for Record

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

Formats the value using the given formatter.

impl PartialEq<Record> for Record

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for Record