Struct ReadFilePayload 

pub struct ReadFilePayload {
    pub path: WorkspacePath,
    pub max_bytes: Option<usize>,
}

Typed payload for reading a workspace file.

Fields

path: WorkspacePath

Root-relative file path.

max_bytes: Option<usize>

Maximum bytes returned by the read.

Implementations

impl ReadFilePayload

pub fn into_effect(self) -> Result<EffectRequest, CodingError>

Converts this payload into an EffectRequest.

Errors

Returns CodingError::InvalidPayload if JSON serialization fails.

pub fn from_effect(request: &EffectRequest) -> Result<Self, CodingError>

Decodes this payload from a matching EffectRequest.

Errors

Returns CodingError if the kind or payload is invalid.

Trait Implementations

impl Clone for ReadFilePayload

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ReadFilePayload

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ReadFilePayload

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ReadFilePayload

impl PartialEq for ReadFilePayload

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ReadFilePayload

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ReadFilePayload