Skip to main content

FileWatcherNode

Struct FileWatcherNode 

Source
pub struct FileWatcherNode<Context, Action>
where Context: Send + Sync + 'static, Action: ActionType + Send + Sync + 'static + Debug,
{ /* private fields */ }
Expand description

A node that watches a file for changes

Implementations§

Source§

impl<Context, Action> FileWatcherNode<Context, Action>
where Context: Send + Sync + 'static, Action: ActionType + Send + Sync + 'static + Debug,

Source

pub fn new<P: Into<String>>(file_path: P) -> Self

Create a new file watcher node

Source

pub fn with_id<P: Into<String>>(file_path: P) -> Self

Create a new file watcher node with a specified ID

Source

pub fn with_poll_interval(self, interval: Duration) -> Self

Set the poll interval for the file watcher

Source

pub fn with_change_handler<F, Fut>(self, handler: F) -> Self
where F: Fn(FileChange, &mut Context) -> Fut + Send + Sync + 'static, Fut: Future<Output = Result<Action, FloxideError>> + Send + 'static,

Set the change handler for the file watcher node

Trait Implementations§

Source§

impl<Context, Action> ReactiveNode<FileChange, Context, Action> for FileWatcherNode<Context, Action>
where Context: Send + Sync + 'static, Action: ActionType + Send + Sync + 'static + Debug,

Source§

fn react_to_change<'life0, 'life1, 'async_trait>( &'life0 self, change: FileChange, context: &'life1 mut Context, ) -> Pin<Box<dyn Future<Output = Result<Action, FloxideError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Reacts to a file change and produces an action

Source§

fn watch<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Box<dyn Stream<Item = FileChange> + Send + Unpin>, FloxideError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Set up a stream of changes to watch
Source§

fn id(&self) -> NodeId

Get the node’s unique identifier

Auto Trait Implementations§

§

impl<Context, Action> Freeze for FileWatcherNode<Context, Action>

§

impl<Context, Action> !RefUnwindSafe for FileWatcherNode<Context, Action>

§

impl<Context, Action> Send for FileWatcherNode<Context, Action>

§

impl<Context, Action> Sync for FileWatcherNode<Context, Action>

§

impl<Context, Action> Unpin for FileWatcherNode<Context, Action>

§

impl<Context, Action> UnsafeUnpin for FileWatcherNode<Context, Action>

§

impl<Context, Action> !UnwindSafe for FileWatcherNode<Context, Action>

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

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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, 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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more