Struct SensitiveString 

pub struct SensitiveString(Sensitive<String>);

FFI-friendly concrete wrapper around a sensitive String. This is the type exposed across the UniFFI / WASM boundary; bindings see it as an opaque tagged string. Debug and Display delegate to the inner Sensitive, so output is redacted unless dangerous-crypto-debug is enabled.

Tuple Fields

0: Sensitive<String>

Implementations

impl SensitiveString

pub fn as_bytes(&self) -> SensitiveSlice<'_>

Borrow the secret as a zero-copy SensitiveSlice over its UTF-8 bytes. The returned slice borrows from this value and stays wrapped, so the bytes are never exposed and the borrow cannot outlive self.

Trait Implementations

impl<UT> ConvertError<UT> for SensitiveString

fn try_convert_unexpected_callback_error( e: UnexpectedUniFFICallbackError, ) -> Result<Self>

impl Debug for SensitiveString

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SensitiveString

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Display for SensitiveString

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

Formats the value using the given formatter.

impl ExposeSensitive for SensitiveString

type Exposed = String

The type of the inner value that is being wrapped. This is used to define the return type of the expose and expose_owned methods.

fn expose(&self) -> &Self::Exposed

Explicitly borrow the secret value. This exposes the secret to logging. This should be used exactly only when interacting with APIs we do not control. Each usage of expose MUST have a comment justifying why it is necessary and acknowledging that the appropriate checks have been performed.

fn expose_owned(self) -> Self::Exposed

Consume the wrapper and return the inner value. This exposes the secret to logging. This should be used exactly only when interacting with APIs we do not control. Each usage of expose MUST have a comment justifying why it is necessary and acknowledging that the appropriate checks have been performed.

impl<UT> FfiConverter<UT> for SensitiveString

const TYPE_ID_META: MetadataBuffer

Type ID metadata, serialized into a [MetadataBuffer].

type FfiType = <String as Lower<UniFfiTag>>::FfiType

The low-level type used for passing values of this type over the FFI.

fn lower(obj: SensitiveString) -> Self::FfiType

Lower a rust value of the target type, into an FFI value of type Self::FfiType.

fn try_lift(v: Self::FfiType) -> Result<SensitiveString>

Lift a rust value of the target type, from an FFI value of type Self::FfiType.

fn write(obj: SensitiveString, buf: &mut Vec<u8>)

Write a rust value into a buffer, to send over the FFI in serialized form.

fn try_read(buf: &mut &[u8]) -> Result<SensitiveString>

Read a rust value from a buffer, received over the FFI in serialized form.

impl From<&str> for SensitiveString

fn from(value: &str) -> Self

Converts to this type from the input type.

impl From<SensitiveString> for JsValue

fn from(value: SensitiveString) -> Self

Converts to this type from the input type.

impl From<String> for SensitiveString

fn from(value: String) -> Self

Converts to this type from the input type.

impl FromWasmAbi for SensitiveString

type Abi = <String as FromWasmAbi>::Abi

The Wasm ABI type that this converts from when coming back out from the ABI boundary.

unsafe fn from_abi(abi: Self::Abi) -> Self

Recover a Self from Self::Abi.

impl IntoWasmAbi for SensitiveString

type Abi = <String as IntoWasmAbi>::Abi

The Wasm ABI type that this converts into when crossing the ABI boundary.

fn into_abi(self) -> Self::Abi

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl<UT> Lift<UT> for SensitiveString

type FfiType = <SensitiveString as FfiConverter<UT>>::FfiType

fn try_lift(v: Self::FfiType) -> Result<Self>

fn try_read(buf: &mut &[u8]) -> Result<Self>

fn try_lift_from_rust_buffer(v: RustBuffer) -> Result<Self, Error>

Convenience method

impl<UT> LiftRef<UT> for SensitiveString

type LiftType = SensitiveString

impl<UT> LiftReturn<UT> for SensitiveString

type ReturnType = <SensitiveString as Lift<UT>>::FfiType

FFI return type for trait interfaces

fn try_lift_successful_return(v: Self::ReturnType) -> Result<Self>

Lift a successfully returned value from a trait interface

fn lift_foreign_return( ffi_return: Self::ReturnType, call_status: RustCallStatus, ) -> Self

Lift a foreign returned value from a trait interface

fn lift_error(_buf: RustBuffer) -> Self

Lift a Rust value for a callback interface method error result

fn handle_callback_unexpected_error(e: UnexpectedUniFFICallbackError) -> Self

Lift a Rust value for an unexpected callback interface error

impl<UT> Lower<UT> for SensitiveString

type FfiType = <SensitiveString as FfiConverter<UT>>::FfiType

fn lower(obj: Self) -> Self::FfiType

fn write(obj: Self, buf: &mut Vec<u8>)

fn lower_into_rust_buffer(obj: Self) -> RustBuffer

Convenience method

impl<UT> LowerError<UT> for SensitiveString

fn lower_error(obj: Self) -> RustBuffer

Lower this value for scaffolding function return

impl<UT> LowerReturn<UT> for SensitiveString

type ReturnType = <SensitiveString as Lower<UT>>::FfiType

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

fn lower_return(v: Self) -> Result<Self::ReturnType, RustCallError>

Lower the return value from an scaffolding call

fn handle_failed_lift( error: LiftArgsError, ) -> Result<Self::ReturnType, RustCallError>

Lower the return value for failed argument lifts

impl OptionFromWasmAbi for SensitiveString

fn is_none(abi: &Self::Abi) -> bool

Tests whether the argument is a “none” instance. If so it will be deserialized as None, and otherwise it will be passed to FromWasmAbi.

impl OptionIntoWasmAbi for SensitiveString

fn none() -> Self::Abi

Returns an ABI instance indicating “none”, which JS will interpret as the None branch of this option.

impl PartialEq for SensitiveString

fn eq(&self, other: &Self) -> 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 Serialize for SensitiveString

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl TryFrom<JsValue> for SensitiveString

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(value: JsValue) -> Result<Self, Self::Error>

Performs the conversion.

impl<UT> TypeId<UT> for SensitiveString

const TYPE_ID_META: MetadataBuffer

impl WasmDescribe for SensitiveString

fn describe()