Skip to main content

DataFlow

Struct DataFlow 

Source
pub struct DataFlow {
    pub reads: bool,
    pub writes: bool,
    pub egress: bool,
    pub egress_scopes: Vec<EgressScope>,
}
Expand description

Declares what a provider does with data, so a host can gate consent before ever sending it a query.

Not Copy: egress_scopes is an owned Vec, so a DataFlow is cloned, not bit-copied.

Fields§

§reads: bool

Can see workspace content via query payloads.

§writes: bool

The provider durably persists data derived from what it receives — indexing query payloads, retaining request logs, and the like.

This is a consent-surface declaration, not a capability flag: it does not imply any host-callable write method, and none exists (see ADR 0004). It is kept because “you may read my workspace” and “you may durably record things about me” are different grants, and a user deserves to be told about the second one.

§egress: bool

Sends anything off the local machine. A host MUST require explicit, one-time consent before enabling a provider with egress: true.

§egress_scopes: Vec<EgressScope>

The egress scopes this provider’s served content falls under (docs/context-reuse.md §3). Empty ⇒ the provider declares only the boolean egress posture (the pre-scope contract). An off-machine scope here is only consistent with egress == true (see scopes_consistent); a scope governs every frame the provider serves.

Implementations§

Source§

impl DataFlow

Source

pub fn off_machine_scopes(&self) -> impl Iterator<Item = &EgressScope>

The declared scopes whose content leaves the machine (EgressScope::is_off_machine).

Source

pub fn scopes_consistent(&self) -> bool

Whether the declared scopes are truthful and well-formed (docs/context-reuse.md §3, requirement C5). A host holds a provider to this at the handshake:

  • every declared scope MUST be well-formed (EgressScope::is_valid — custom scopes must be namespaced);
  • an off-machine scope alongside egress: false is a lie — a provider cannot claim local-only posture while declaring content leaves. (The converse is allowed: egress: true with no scopes is the legacy boolean contract.)

Trait Implementations§

Source§

impl Clone for DataFlow

Source§

fn clone(&self) -> DataFlow

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 Debug for DataFlow

Source§

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

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

impl Default for DataFlow

Source§

fn default() -> DataFlow

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for DataFlow

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Eq for DataFlow

Source§

impl PartialEq for DataFlow

Source§

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

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

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

Inequality operator !=. Read more
Source§

impl Serialize for DataFlow

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for DataFlow

Auto Trait Implementations§

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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> Same for T

Source§

type Output = T

Should always be Self
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.