Skip to main content

Document

Struct Document 

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

A .flow file open for editing. The text is the source of truth; the graph is a view of it.

use flow_runner::{Document, Edit};

let mut doc = Document::parse("edition 2026\nflow f\nentry a\n\nnode a = { \"ok\": true }\n");
doc.apply(Edit::RenameNode { from: "a".into(), to: "start".into() }).unwrap();
assert_eq!(doc.text(), "edition 2026\nflow f\nentry start\n\nnode start = { \"ok\": true }\n");
assert!(doc.diagnostics().is_empty());

Implementations§

Source§

impl Document

Source

pub fn graph(&self) -> Graph

The flow as a Graph to draw.

Source§

impl Document

Source

pub fn parse(text: impl Into<String>) -> Document

Open a file. Never fails: problems are in diagnostics, and the graph shows every declaration that parsed. A file over MAX_SOURCE_BYTES isn’t read at all.

Source

pub fn text(&self) -> &str

The file as it stands, to save.

Source

pub fn diagnostics(&self) -> &Diagnostics

Every error and warning, as Flow::check reports them.

Source

pub fn apply(&mut self, edit: Edit) -> Result<(), EditError>

Apply one edit. On error the document is unchanged. An edit that parses but leaves the flow wrong, such as removing a node others jump to, is applied, and the problem shows in the diagnostics. An edit that would change more of the file than it asks for is refused.

Trait Implementations§

Source§

impl Clone for Document

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

Source§

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

Formats the value using the given formatter. Read more

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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.