Skip to main content

Frame

Struct Frame 

Source
pub struct Frame { /* private fields */ }
Expand description

A complete protocol frame

Implementations§

Source§

impl Frame

Source

pub fn new(verb: Verb, payload: Payload) -> Self

Create a new frame

Source

pub fn simple(verb: Verb) -> Self

Create a simple frame with no payload

Source

pub fn verb(&self) -> Verb

Get the verb

Source

pub fn payload(&self) -> &Payload

Get the payload

Source

pub fn into_payload(self) -> Payload

Consume and return the payload

Source

pub fn encode(&self) -> Vec<u8>

Encode frame for wire transmission

Source

pub fn decode(data: &[u8]) -> ProtocolResult<Self>

Decode frame from wire format

Source

pub fn is_valid(data: &[u8]) -> bool

Check if frame is valid (verb + END marker present)

Source

pub fn find_end(data: &[u8]) -> Option<usize>

Find the end of a frame in a buffer (returns length including END)

Source§

impl Frame

Source

pub fn ping() -> Self

Create a PING frame

Source

pub fn stats() -> Self

Create a STATS frame

Source

pub fn ok() -> Self

Create an OK/ACK frame

Source

pub fn error(message: &str) -> Self

Create an ERROR frame with message

Source

pub fn scan(path: &str, depth: u8) -> Self

Create a SCAN frame

Source

pub fn search(pattern: &str) -> Self

Create a SEARCH frame (simple - pattern only)

Source

pub fn search_path(path: &str, pattern: &str, max_results: u8) -> Self

Create a SEARCH frame with path, pattern, and max results

Source

pub fn format(mode: &str) -> Self

Create a FORMAT frame with just mode (lists formats)

Source

pub fn format_path(mode: &str, path: &str, depth: u8) -> Self

Create a FORMAT frame with mode, path, and depth (scans and formats)

Source

pub fn remember(content: &str, keywords: &str, memory_type: &str) -> Self

Create a REMEMBER frame

Source

pub fn recall(keywords: &str, max_results: u8) -> Self

Create a RECALL frame

Source

pub fn forget(memory_id: &str) -> Self

Create a FORGET frame

Source

pub fn m8_wave() -> Self

Create an M8_WAVE frame (get memory stats)

Source

pub fn audio(acoustic_bytes: &[u8]) -> Self

Create an AUDIO frame with AcousticMemory data

Payload format: [AYE8 magic + serialized AcousticMemory bytes] The bytes should be from liquid-rust’s AcousticMemory::to_bytes()

Source

pub fn audio_simple(text: &str, valence: f32, arousal: f32) -> Self

Create an AUDIO frame with text and emotion (simplified)

For when you don’t have full AcousticMemory, just text + emotion

Trait Implementations§

Source§

impl Clone for Frame

Source§

fn clone(&self) -> Frame

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Frame

Source§

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

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

impl PartialEq for Frame

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · 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 Eq for Frame

Source§

impl StructuralPartialEq for Frame

Auto Trait Implementations§

§

impl Freeze for Frame

§

impl RefUnwindSafe for Frame

§

impl Send for Frame

§

impl Sync for Frame

§

impl Unpin for Frame

§

impl UnsafeUnpin for Frame

§

impl UnwindSafe for Frame

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> 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.