Struct fiberplane_models::notebooks::ProviderCell

#[non_exhaustive]
pub struct ProviderCell {
    pub id: String,
    pub intent: String,
    pub query_data: Option<String>,
    pub response: Option<EncodedBlob>,
    pub output: Option<Vec<Cell>>,
    pub read_only: Option<bool>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

id: String

intent: String

The intent served by this provider cell.

See: https://www.notion.so/fiberplane/RFC-45-Provider-Protocol-2-0-Revised-4ec85a0233924b2db0010d8cdae75e16#c8ed5dfbfd764e6bbd5c5b79333f9d6e

query_data: Option<String>

Query data encoded as "<mime-type>,<data>", where the MIME type is either "application/x-www-form-urlencoded" or "multipart/form-data". This is used for storing data for the Query Builder.

Note: The format follows the specification for data URLs, without the data: prefix. See: https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URLs

response: Option<EncodedBlob>

Optional response data from the provider.

output: Option<Vec<Cell>>

Optional list of generated output cells.

read_only: Option<bool>

Implementations

impl ProviderCell

pub fn builder() -> ProviderCellBuilder<((), (), (), (), (), ())>

Create a builder for building ProviderCell. On the builder, call .id(...)(optional), .intent(...)(optional), .query_data(...)(optional), .response(...)(optional), .output(...)(optional), .read_only(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of ProviderCell.

impl ProviderCell

pub fn with_query_field( &self, field_name: impl AsRef<str>, value: impl AsRef<str> ) -> Self

Returns a clone of the provider cell, with the query data updated for the given query field.

Unsets the query field if the value is empty.

Trait Implementations

impl Clone for ProviderCell

fn clone(&self) -> ProviderCell

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ProviderCell

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

Formats the value using the given formatter.

impl Default for ProviderCell

fn default() -> ProviderCell

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ProviderCell

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ProviderCell

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ProviderCell

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 ProviderCell