Skip to main content

FeedFrame

Struct FeedFrame 

Source
#[non_exhaustive]
pub struct FeedFrame<'a> { pub offset: u64, pub bytes: &'a [u8], }
Expand description

One decoded feed entry: the offset plus the frame’s wire bytes (envelope + offset + RESP argv — same encoding replicas consume; crate::wire::decode_frame parses it).

use kevy_replicate::feed::{FeedPosition, FeedSource};
use kevy_replicate::source::ReplicationSource;

let mut feed = FeedSource::new(1, ReplicationSource::new(1 << 20));
let set = kevy_resp::Argv::from(vec![b"SET".to_vec(), b"k".to_vec(), b"v".to_vec()]);
feed.source_mut().push_mutation(&set);
let frames = feed.read(FeedPosition::new(1, 0), 10).expect("offset 0 is buffered");
let (decoded, _) = kevy_replicate::wire::decode_frame(frames[0].bytes)?;
assert_eq!((frames[0].offset, decoded.argv), (0, set));

Fields (Non-exhaustive)§

This struct is marked as 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.
§offset: u64

Offset the source assigned at push time.

use kevy_replicate::feed::{FeedPosition, FeedSource};
use kevy_replicate::source::ReplicationSource;

let mut feed = FeedSource::new(1, ReplicationSource::new(1 << 20));
let set = kevy_resp::Argv::from(vec![b"SET".to_vec(), b"k".to_vec(), b"v".to_vec()]);
for _ in 0..3 {
    feed.source_mut().push_mutation(&set);
}
let frames = feed.read(FeedPosition::new(1, 1), 10)?;
assert_eq!(frames.iter().map(|f| f.offset).collect::<Vec<_>>(), [1, 2]);
§bytes: &'a [u8]

Wire-encoded frame bytes.

use kevy_replicate::feed::{FeedPosition, FeedSource};
use kevy_replicate::source::ReplicationSource;

let mut feed = FeedSource::new(1, ReplicationSource::new(1 << 20));
let set = kevy_resp::Argv::from(vec![b"SET".to_vec(), b"k".to_vec(), b"v".to_vec()]);
feed.source_mut().push_mutation(&set);
let frames = feed.read(FeedPosition::new(1, 0), 1)?;
assert_eq!(frames[0].bytes, kevy_replicate::wire::encode_frame(0, &set));

Trait Implementations§

Source§

impl<'a> Clone for FeedFrame<'a>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<'a> Copy for FeedFrame<'a>

Source§

impl<'a> Debug for FeedFrame<'a>

Source§

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

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

impl<'a> Eq for FeedFrame<'a>

Source§

impl<'a> Hash for FeedFrame<'a>

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl<'a> PartialEq for FeedFrame<'a>

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl<'a> StructuralPartialEq for FeedFrame<'a>

Auto Trait Implementations§

§

impl<'a> Freeze for FeedFrame<'a>

§

impl<'a> RefUnwindSafe for FeedFrame<'a>

§

impl<'a> Send for FeedFrame<'a>

§

impl<'a> Sync for FeedFrame<'a>

§

impl<'a> Unpin for FeedFrame<'a>

§

impl<'a> UnsafeUnpin for FeedFrame<'a>

§

impl<'a> UnwindSafe for FeedFrame<'a>

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 = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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.