Struct ironcore_alloy::AlloyMetadata

pub struct AlloyMetadata { /* private fields */ }

Holds metadata fields as part of an SDK call. Each encrypted value will have metadata that associates it to a tenant ID as well as optional fields for other arbitrary key/value pairs and a request ID to send to the Tenant Security Proxy. Only the tenant ID will be used in Standalone SDKs, which can be created easily with new_simple().

Implementations

impl AlloyMetadata

pub fn new( tenant_id: TenantId, requesting_user_or_service_id: Option<String>, data_label: Option<String>, source_ip: Option<String>, object_id: Option<String>, request_id: Option<String>, other_data: HashMap<String, String> ) -> Arc<Self>

Constructor for AlloyMetadata which contains the tenant’s ID and other metadata to send to the Tenant Security Proxy.

Arguments

• tenant_id - Unique ID of tenant that is performing the operation.
• requesting_user_or_service_id - Unique ID of user/service that is processing data. Must be non-empty.
• data_label - Classification of data being processed.
• source_ip - IP address of the initiator of this document request.
• object_id - ID of the object/document being acted on in the host system.
• request_id - Unique ID that ties host application request ID to tenant.
• other_data - Additional String key/value pairs to add to metadata.

pub fn new_simple(tenant_id: TenantId) -> Arc<Self>

Simplified constructor for AlloyMetadata that only takes the tenant’s ID and the ID of the user/service that is processing data.

Arguments

• tenant_id - Unique ID of tenant that is performing the operation.

Trait Implementations

impl Clone for AlloyMetadata

fn clone(&self) -> AlloyMetadata

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AlloyMetadata

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

Formats the value using the given formatter.

impl<T> LiftRef<T> for AlloyMetadata

type LiftType = Arc<AlloyMetadata>

impl<T> LowerReturn<T> for AlloyMetadata

type ReturnType = <AlloyMetadata as FfiConverterArc<UniFfiTag>>::FfiType

The type that should be returned by scaffolding functions for this type.

fn lower_return(obj: Self) -> Result<Self::ReturnType, RustBuffer>

Lower this value for scaffolding function return

const TYPE_ID_META: MetadataBuffer = _

fn handle_failed_lift(arg_name: &str, e: Error) -> Self

If possible, get a serialized error for failed argument lifts

impl Serialize for AlloyMetadata

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.