Struct zng_view_api::api_extension::ApiExtensionPayload

pub struct ApiExtensionPayload(pub Vec<u8>);

Custom serialized data, in a format defined by the extension.

Note that the bytes here should represent a serialized small struct only, you can add an IpcBytes or IpcBytesReceiver field to this struct to transfer large payloads.

Tuple Fields

0: Vec<u8>

Implementations

impl ApiExtensionPayload

pub fn serialize<T: Serialize>(payload: &T) -> Result<Self>

Serialize the payload.

pub fn deserialize<T: DeserializeOwned>( &self, ) -> Result<T, ApiExtensionRecvError>

Deserialize the payload.

pub const fn empty() -> Self

Empty payload.

pub fn unknown_extension(extension_id: ApiExtensionId) -> Self

Value returned when an invalid extension is requested.

Value is a string "zng-view-api.unknown_extension;id={extension_id}".

pub fn invalid_request( extension_id: ApiExtensionId, error: impl Display, ) -> Self

Value returned when an invalid request is made for a valid extension key.

Value is a string "zng-view-api.invalid_request;id={extension_id};error={error}".

pub fn parse_unknown_extension(&self) -> Option<ApiExtensionId>

If the payload is an unknown_extension error message, returns the key.

if the payload starts with the invalid request header and the key cannot be retrieved the ApiExtensionId::INVALID is returned as the key.

pub fn parse_invalid_request(&self) -> Option<(ApiExtensionId, &str)>

If the payload is an invalid_request error message, returns the key and error.

if the payload starts with the invalid request header and the key cannot be retrieved the ApiExtensionId::INVALID is returned as the key and the error message will mention “corrupted payload”.

Trait Implementations

impl Clone for ApiExtensionPayload

fn clone(&self) -> ApiExtensionPayload

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ApiExtensionPayload

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ApiExtensionPayload

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for ApiExtensionPayload

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ApiExtensionPayload

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for ApiExtensionPayload

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for ApiExtensionPayload

impl StructuralPartialEq for ApiExtensionPayload