Struct SendClient 

pub struct SendClient {
    pub(crate) client: Client,
}

Fields

client: Client

Implementations

impl SendClient

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 client-side using the key derived 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.

impl SendClient

pub fn decrypt(&self, send: Send) -> Result<SendView, SendDecryptError>

pub fn decrypt_list( &self, sends: Vec<Send>, ) -> Result<Vec<SendListView>, SendDecryptError>

pub fn decrypt_file( &self, send: Send, encrypted_file_path: &Path, decrypted_file_path: &Path, ) -> Result<(), SendDecryptFileError>

pub fn decrypt_buffer( &self, send: Send, encrypted_buffer: &[u8], ) -> Result<Vec<u8>, SendDecryptError>

pub fn encrypt(&self, send_view: SendView) -> Result<Send, SendEncryptError>

pub fn encrypt_file( &self, send: Send, decrypted_file_path: &Path, encrypted_file_path: &Path, ) -> Result<(), SendEncryptFileError>

pub fn encrypt_buffer( &self, send: Send, buffer: &[u8], ) -> Result<Vec<u8>, SendEncryptError>

impl SendClient

pub async fn create( &self, request: SendAddRequest, ) -> Result<SendView, CreateSendError>

Create a new Send and save it to the server.

impl SendClient

pub async fn create_file_send( &self, request: SendAddRequest, file_buffer: Vec<u8>, ) -> Result<CreateFileSendResponse, CreateFileSendError>

Create a new file Send and save it to the server.

file_buffer is the plaintext file content. It is encrypted internally under the send key derived for this send, and its ciphertext length is sent to the server as file_length so the server can enforce storage quotas before the upload (matching the legacy client’s encrypt-then-create ordering).

Returns the created send, the encrypted file bytes, and the metadata needed to upload them. After calling this, hand CreateFileSendResponse::encrypted_file_buffer and the upload metadata to SendClient::upload_send_file.

pub async fn upload_send_file( &self, send_id: SendId, file_id: String, encrypted_file_name: String, file_upload_type: FileUploadType, upload_url: String, data: Vec<u8>, ) -> Result<(), UploadSendFileError>

Upload the encrypted file data for a file Send.

data must be the encrypted file content (encrypted with the send key). encrypted_file_name is the encrypted file name string from CreateFileSendResponse.

file_upload_type and upload_url come from CreateFileSendResponse and select the upload backend:

• FileUploadType::Direct uploads directly to the Bitwarden server via a multipart POST. The upload_url is ignored in this case (the direct endpoint is derived from the send and file IDs).
• FileUploadType::Azure PUTs the ciphertext to the pre-signed Azure Blob Storage upload_url. If that URL has expired, it is renewed once via SendClient::renew_file_upload_url and the upload is retried.

pub async fn renew_file_upload_url( &self, send_id: SendId, file_id: String, ) -> Result<String, RenewFileUploadUrlError>

Renew the upload URL for a file Send.

Returns a fresh upload URL if the previous one has expired.

impl SendClient

pub async fn delete(&self, send_id: SendId) -> Result<(), DeleteSendError>

Delete a Send from the server and remove it from local state.

impl SendClient

pub async fn edit( &self, send_id: SendId, request: SendEditRequest, ) -> Result<SendView, EditSendError>

Edit the Send and save it to the server.

impl SendClient

pub async fn list(&self) -> Result<Vec<SendView>, GetSendError>

Get all sends from state and decrypt them to a list of SendView.

pub async fn get(&self, send_id: SendId) -> Result<SendView, GetSendError>

Get a specific Send by its ID from state and decrypt it to a SendView.

impl SendClient

pub async fn remove_password( &self, send_id: SendId, ) -> Result<SendView, RemoveSendPasswordError>

Remove the password from a Send, saving the updated state to the server and local state.

Trait Implementations

impl From<SendClient> for JsValue

fn from(value: SendClient) -> JsValue

Converts to this type from the input type.

impl FromWasmAbi for SendClient

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) -> SendClient

Recover a Self from Self::Abi.

impl IntoWasmAbi for SendClient

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 SendClient

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RcRef<SendClient>

Same as RefFromWasmAbi::Anchor

unsafe fn long_ref_from_abi( js: <SendClient as LongRefFromWasmAbi>::Abi, ) -> <SendClient as LongRefFromWasmAbi>::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl OptionFromWasmAbi for SendClient

fn is_none(abi: &<SendClient as FromWasmAbi>::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 SendClient

fn none() -> <SendClient as IntoWasmAbi>::Abi

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

impl RefFromWasmAbi for SendClient

type Abi = u32

The Wasm ABI type references to Self are recovered from.

type Anchor = RcRef<SendClient>

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: <SendClient as RefFromWasmAbi>::Abi, ) -> <SendClient as RefFromWasmAbi>::Anchor

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

impl RefMutFromWasmAbi for SendClient

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RcRefMut<SendClient>

Same as RefFromWasmAbi::Anchor

unsafe fn ref_mut_from_abi( js: <SendClient as RefMutFromWasmAbi>::Abi, ) -> <SendClient as RefMutFromWasmAbi>::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl TryFromJsValue for SendClient

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

Performs the conversion.

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

Performs the conversion.

impl VectorFromWasmAbi for SendClient

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

unsafe fn vector_from_abi( js: <SendClient as VectorFromWasmAbi>::Abi, ) -> Box<[SendClient]>

impl VectorIntoWasmAbi for SendClient

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

fn vector_into_abi( vector: Box<[SendClient]>, ) -> <SendClient as VectorIntoWasmAbi>::Abi