Struct Modify

pub struct Modify<S: ExtendVec + 'static = Vec<u8>> { /* private fields */ }

A modification to a resource.

The resource must be initialised using Create.

Implementations

impl Modify

pub fn new(resource: String, target: &[u8], base: &[u8]) -> Self

Get the difference needed to get from base to target, as a modify event.

pub fn new_with_verification( resource: String, target: &[u8], base: &[u8], ) -> Self

Get the difference needed to get from base to target, as a modify event.

This also verifies that the Modify::diff gives target. Using this over Self::new is only recommended when you have data that MUST be transmitted correctly.

Most errors will however resolve once the client reconnects to the network or if a server, performs a hash check.

This does not trigger an allocation.

If the verification failed, we send the whole resource.

impl<S: ExtendVec + 'static> Modify<S>

pub fn diff(&self) -> &Difference<S>

Get a reference to the sections of data this event modifies.

pub fn resource(&self) -> &str

Returns a reference to the target resource name.

Trait Implementations

impl<S: Clone + ExtendVec + 'static> Clone for Modify<S>

fn clone(&self) -> Modify<S>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S: ExtendVec + AsRef<[u8]> + 'static> Debug for Modify<S>

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

Formats the value using the given formatter.

impl<'de, S> Deserialize<'de> for Modify<S>

where S: Deserialize<'de> + ExtendVec + 'static,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<S: ExtendVec + 'static> From<Modify<S>> for Kind<S>

fn from(event: Modify<S>) -> Self

Converts to this type from the input type.

impl<S: ExtendVec + 'static> IntoEvent<S> for Modify<S>

fn into_ev(self, manager: &Manager) -> Event<S>

Converts self into an Event.

impl<S: PartialEq + ExtendVec + 'static> PartialEq for Modify<S>

fn eq(&self, other: &Modify<S>) -> 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<S> Serialize for Modify<S>

where S: Serialize + ExtendVec + 'static,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<S: Eq + ExtendVec + 'static> Eq for Modify<S>

impl<S: ExtendVec + 'static> StructuralPartialEq for Modify<S>