Skip to main content

ResourceWriteParams

Struct ResourceWriteParams 

Source
pub struct ResourceWriteParams {
    pub channel: Uri,
    pub uri: Uri,
    pub data: String,
    pub encoding: ContentEncoding,
    pub content_type: Option<String>,
    pub create_only: Option<bool>,
    pub mode: Option<ResourceWriteMode>,
    pub position: Option<i64>,
    pub if_match: Option<String>,
}
Expand description

Writes content to a file on the server’s filesystem.

Binary content (images, etc.) MUST use base64 encoding. Text content MAY use utf-8 encoding.

If the file does not exist, it is created. If the file already exists, the effect on existing bytes depends on {@link ResourceWriteParams.mode}: truncate (default) overwrites from the chosen offset onward, append preserves all existing bytes and adds data at a position rooted at EOF, and insert preserves all existing bytes and splices data in at an offset rooted at the start of the file.

Like all resource* methods, resourceWrite is symmetrical and MAY be sent in either direction.

Fields§

§channel: Uri

Channel URI this command targets.

§uri: Uri

Target file URI on the server filesystem

§data: String

Content encoded as a string

§encoding: ContentEncoding

How data is encoded

§content_type: Option<String>

Content type (e.g. "text/plain", "image/png")

§create_only: Option<bool>

If true, the server MUST fail if the file already exists instead of overwriting it. Useful for safe creation of new files.

§mode: Option<ResourceWriteMode>

How data is placed within the target file. Defaults to 'truncate' (full overwrite) when omitted. See {@link ResourceWriteMode} for the meaning of each mode and how it interprets {@link position}.

§position: Option<i64>

Byte offset interpreted according to {@link mode}. Defaults to 0.

  • truncate: offset from the start of the file at which to truncate before writing.
  • append: bytes back from EOF at which to insert data.
  • insert: offset from the start of the file at which to splice in data.
§if_match: Option<String>

Optimistic-concurrency token previously returned by {@link ResourceResolveResult.etag}. When set, the server MUST fail with Conflict if the current etag does not match — preventing lost updates between a resourceResolve and a subsequent resourceWrite.

Trait Implementations§

Source§

impl Clone for ResourceWriteParams

Source§

fn clone(&self) -> ResourceWriteParams

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ResourceWriteParams

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for ResourceWriteParams

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for ResourceWriteParams

Source§

fn eq(&self, other: &ResourceWriteParams) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for ResourceWriteParams

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for ResourceWriteParams

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.