Struct EffectResponse 

pub struct EffectResponse {
    pub message_type: &'static str,
    pub session: String,
    pub id: String,
    pub status: &'static str,
    pub result: Option<Value>,
    pub error: Option<String>,
}

Response to an effect request, written to stdout as JSONL.

Fields

message_type: &'static str

session: String

id: String

status: &'static str

result: Option<Value>

error: Option<String>

Implementations

impl EffectResponse

pub fn ok(id: String, result: Value) -> Self

The effect completed successfully with the given result.

pub fn error(id: String, reason: String) -> Self

The effect failed with the given reason.

pub fn unsupported(id: String) -> Self

The requested effect kind is not supported.

pub fn cancelled(id: String) -> Self

The user cancelled the operation (e.g. closed a file dialog). Distinct from error – cancellation is a normal user action, not a failure.

pub fn with_session(self, session: impl Into<String>) -> Self

Set the session ID for this response.

Trait Implementations

impl Debug for EffectResponse

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

Formats the value using the given formatter.

impl Serialize for EffectResponse

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

where __S: Serializer,

Serialize this value into the given Serde serializer.