Struct AttachmentsClient 

pub struct AttachmentsClient {
    pub(crate) key_store: KeyStore<KeySlotIds>,
    pub(crate) api_configurations: Arc<ApiConfigurations>,
    pub(crate) repository: Option<Arc<dyn Repository<Cipher>>>,
    pub(crate) http_client: Client,
}

Wrapper for attachment-specific cipher operations.

Fields

key_store: KeyStore<KeySlotIds>

api_configurations: Arc<ApiConfigurations>

repository: Option<Arc<dyn Repository<Cipher>>>

http_client: Client

Implementations

impl AttachmentsClient

pub async fn create_attachment( &self, cipher_id: CipherId, request: CreateAttachmentRequest, ) -> Result<CreatedAttachment, CipherCreateAttachmentError>

Creates a new attachment slot on the server and updates local repository state with the merged cipher returned by the server.

The caller must upload the encrypted bytes to CreatedAttachment::upload_url using the transport in CreatedAttachment::file_upload_type.

If a later step fails after slot creation, the SDK best-effort deletes the orphaned slot and returns the original error.

async fn finalize_create( &self, response: AttachmentUploadDataResponseModel, existing_cipher: Option<Cipher>, cipher_id: CipherId, as_admin: bool, ) -> Result<CreatedAttachment, CipherCreateAttachmentError>

impl AttachmentsClient

pub async fn delete_attachment( &self, cipher_id: CipherId, attachment_id: String, ) -> Result<Cipher, CipherDeleteAttachmentError>

Deletes an attachment from a cipher, and updates the local repository with the new cipher data returned from the API.

impl AttachmentsClient

pub async fn get_attachment_download_url( &self, cipher_id: CipherId, attachment_id: String, emergency_access_id: Option<String>, ) -> Result<String, CipherGetAttachmentDownloadUrlError>

Returns the attachment download URL.

With emergency_access_id, uses the emergency-access endpoint and never falls back. Otherwise uses the cipher endpoint and falls back to the local repository on 404.

impl AttachmentsClient

async fn get_emergency_access_attachment_download_url( &self, emergency_access_id: &str, cipher_id: CipherId, attachment_id: &str, ) -> Result<String, CipherGetAttachmentDownloadUrlError>

Fetches an attachment download URL via the emergency-access endpoint.

impl AttachmentsClient

pub async fn renew_file_upload_url( &self, cipher_id: CipherId, attachment_id: String, ) -> Result<String, CipherRenewFileUploadUrlError>

Returns a renewed upload URL for an attachment. Does not modify the attachment slot.

impl AttachmentsClient

pub async fn upgrade_attachment( &self, cipher_id: CipherId, attachment_id: String, ) -> Result<CipherView, CipherUpgradeAttachmentError>

Upgrades a legacy v1 attachment to CipherKey(AttachmentKey(Contents)).

Downloads and re-encrypts the attachment, creates a new slot, uploads the new bytes, then deletes the old attachment. If the upload fails, it tries to delete the new slot before returning the error. Returns the decrypted cipher view.

impl AttachmentsClient

async fn download_and_reencrypt( &self, legacy_key_slot: SymmetricKeySlotId, new_attachment_key: SymmetricCryptoKey, plaintext_size_hint: u64, download_url: &str, ) -> Result<Vec<u8>, CipherUpgradeAttachmentError>

Downloads the legacy ciphertext and re-encrypts it into memory.

Wasm reqwest only supports buffered request bodies so the output is buffered.

async fn upload_reencrypted( &self, cipher_id: CipherId, created: &CreatedAttachment, reencrypted: Vec<u8>, ) -> Result<(), CipherUpgradeAttachmentError>

Uploads the re-encrypted bytes to the newly created attachment slot.

Transport depends on AttachmentFileUploadType: Azure PUTs to the presigned blob URL on the unauthenticated client (the SAS token in the URL authorizes it; a Bearer token must not be attached), while Direct POSTs to the authenticated Bitwarden API endpoint (POST /ciphers/{id}/attachment/{attachmentId}) using the configured API client.

impl AttachmentsClient

pub fn admin(&self) -> AttachmentAdminClient

Returns a new client for performing attachment admin operations. Uses the admin server API endpoints and does not modify local state.

pub fn decrypt_buffer( &self, cipher: Cipher, attachment: AttachmentView, encrypted_buffer: &[u8], ) -> Result<Vec<u8>, DecryptError>

impl AttachmentsClient

pub fn encrypt_buffer( &self, cipher: Cipher, attachment: AttachmentView, buffer: &[u8], ) -> Result<AttachmentEncryptResult, EncryptError>

pub fn encrypt_file( &self, cipher: Cipher, attachment: AttachmentView, decrypted_file_path: &Path, encrypted_file_path: &Path, ) -> Result<Attachment, EncryptFileError>

pub fn decrypt_file( &self, cipher: Cipher, attachment: AttachmentView, encrypted_file_path: &Path, decrypted_file_path: &Path, ) -> Result<(), DecryptFileError>

Trait Implementations

impl From<AttachmentsClient> for JsValue

fn from(value: AttachmentsClient) -> Self

Converts to this type from the input type.

impl FromClient for AttachmentsClient

fn from_client(client: &Client) -> Self

Construct this type from a [Client] reference.

impl FromWasmAbi for AttachmentsClient

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 AttachmentsClient

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 AttachmentsClient

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RcRef<AttachmentsClient>

Same as RefFromWasmAbi::Anchor

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

Same as RefFromWasmAbi::ref_from_abi

impl OptionFromWasmAbi for AttachmentsClient

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 AttachmentsClient

fn none() -> Self::Abi

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

impl RefFromWasmAbi for AttachmentsClient

type Abi = u32

The Wasm ABI type references to Self are recovered from.

type Anchor = RcRef<AttachmentsClient>

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 AttachmentsClient

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RcRefMut<AttachmentsClient>

Same as RefFromWasmAbi::Anchor

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

Same as RefFromWasmAbi::ref_from_abi

impl TryFromJsValue for AttachmentsClient

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 AttachmentsClient

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

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

impl VectorIntoWasmAbi for AttachmentsClient

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

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

impl WasmDescribe for AttachmentsClient

fn describe()

impl WasmDescribeVector for AttachmentsClient

fn describe_vector()

impl SupportsConstructor for AttachmentsClient

impl SupportsInstanceProperty for AttachmentsClient

impl SupportsStaticProperty for AttachmentsClient