Struct SendReceiveClient 

pub struct SendReceiveClient {
    client: Client,
}

Client dedicated to receiving (anonymously accessing) a Send.

Receiving is the only Send operation that may target a different Bitwarden instance than the one the user is signed into: the target server is dictated by the Send link itself (e.g. a self-hosted or other-region server). This client is therefore built from its own [ClientSettings] and carries no user identity, tokens, or key store. Creating and editing Sends never needs this, and should go through the regular SendClient.

Fields

client: Client

Implementations

impl SendReceiveClient

pub fn new(settings: Option<ClientSettings>) -> Self

Create a receive client targeting the instance described by settings.

pub async fn request_send_access_token( &self, request: SendAccessTokenRequest, ) -> Result<SendAccessTokenResponse, SendAccessTokenError>

Requests a send access token from the identity server of the instance this client targets.

For a password-protected Send, the request’s credentials carry the hash returned by Self::hash_send_password. Minting the token here, rather than through a signed-in client, guarantees it (and any password hash) is only ever sent to the server that hosts the Send.

pub fn hash_send_password( &self, key_b64: String, password: String, ) -> Result<String, SendAccessKeyError>

Hash password with the URL-safe-base64 send key into the password_hash_b64 credential expected by Self::request_send_access_token.

pub async fn access_send( &self, access_token: String, ) -> Result<SendAccessResponse, AccessSendError>

Accesses a send, authenticated with a send access token. The returned SendAccessResponse contains encrypted fields that must be decrypted with Self::decrypt_send_access using the key from the URL fragment.

pub async fn get_file_download_data( &self, access_token: String, file_id: String, ) -> Result<SendFileDownloadData, GetFileDownloadDataError>

Gets file download data for a file send, authenticated with a send access token.

pub fn decrypt_send_access( &self, key_b64: String, response: SendAccessResponse, ) -> Result<SendAccessView, SendAccessDecryptError>

Decrypt a SendAccessResponse into a SendAccessView using the URL-safe-base64 send key from the trailing segment of the send URL fragment.

pub fn decrypt_send_access_file( &self, key_b64: String, buffer: &[u8], ) -> Result<Vec<u8>, SendAccessDecryptError>

Decrypt a downloaded file-send blob using the URL-safe-base64 send key.

Trait Implementations

impl From<SendReceiveClient> for JsValue

fn from(value: SendReceiveClient) -> Self

Converts to this type from the input type.

impl FromWasm for SendReceiveClient

Available on crate feature wasm only.

type Wire = SendReceiveClient

The type JavaScript actually passes.

fn from_wire(wire: Self::Wire) -> Result<Self, WireError>

Recovers the Rust value from the wire value.

impl FromWasmAbi for SendReceiveClient

type Abi = u32

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

unsafe fn from_abi(js: u32) -> Self

Recover a Self from Self::Abi.

impl IntoWasmAbi for SendReceiveClient

type Abi = u32

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

fn into_abi(self) -> u32

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

impl LongRefFromWasmAbi for SendReceiveClient

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RcRef<SendReceiveClient>

Same as RefFromWasmAbi::Anchor

unsafe fn long_ref_from_abi(js: Self::Abi) -> Self::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl OptionFromWasmAbi for SendReceiveClient

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 SendReceiveClient

fn none() -> Self::Abi

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

impl RefFromWasmAbi for SendReceiveClient

type Abi = u32

The Wasm ABI type references to Self are recovered from.

type Anchor = RcRef<SendReceiveClient>

The type that holds the reference to Self for the duration of the invocation of the function that has an &Self parameter. This is required to ensure that the lifetimes don’t persist beyond one function call, and so that they remain anonymous.

unsafe fn ref_from_abi(js: Self::Abi) -> Self::Anchor

Recover a Self::Anchor from Self::Abi.

impl RefMutFromWasmAbi for SendReceiveClient

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RcRefMut<SendReceiveClient>

Same as RefFromWasmAbi::Anchor

unsafe fn ref_mut_from_abi(js: Self::Abi) -> Self::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl SupportsConstructor for SendReceiveClient

impl SupportsInstanceProperty for SendReceiveClient

impl SupportsStaticProperty for SendReceiveClient

impl ToWasm for SendReceiveClient

Available on crate feature wasm only.

type Wire = SendReceiveClient

The type JavaScript actually receives.

fn to_wire(self) -> Result<Self::Wire, WireError>

Converts the Rust value into the wire value.

impl TryFromJsValue for SendReceiveClient

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

Performs the conversion.

fn try_from_js_value_ref(value: &JsValue) -> Option<Self>

Performs the conversion.

impl VectorFromWasmAbi for SendReceiveClient

type Abi = <Box<[JsValue]> as FromWasmAbi>::Abi

unsafe fn vector_from_abi(js: Self::Abi) -> Box<[SendReceiveClient]>

impl VectorIntoWasmAbi for SendReceiveClient

type Abi = <Box<[JsValue]> as IntoWasmAbi>::Abi

fn vector_into_abi(vector: Box<[SendReceiveClient]>) -> Self::Abi

impl WasmDescribe for SendReceiveClient

fn describe()

impl WasmDescribeVector for SendReceiveClient

fn describe_vector()