#[non_exhaustive]pub struct WatchEvent { /* private fields */ }Expand description
One normalized provider watch event.
Sequence numbers are interpreted within a provider generation; this type stores but does not validate monotonicity. Rename/move events can carry a previous URI, and any event can carry a stable identity. The struct is non-exhaustive so it can gain correlation fields compatibly.
§Examples
use ailloli_ui_fs::{FileUri, WatchEvent, WatchEventKind};
let event = WatchEvent::new(WatchEventKind::Created, FileUri::parse("file:///new")?, 1, 4);
assert_eq!((event.sequence(), event.generation()), (1, 4));Implementations§
Source§impl WatchEvent
impl WatchEvent
Sourcepub fn new(
kind: WatchEventKind,
uri: FileUri,
sequence: u64,
generation: u64,
) -> Self
pub fn new( kind: WatchEventKind, uri: FileUri, sequence: u64, generation: u64, ) -> Self
Creates an event without previous URI or stable identity.
Zero and non-monotone sequence/generation values are accepted verbatim.
§Examples
use ailloli_ui_fs::{FileUri, WatchEvent, WatchEventKind};
let event = WatchEvent::new(WatchEventKind::Modified, FileUri::parse("file:///a")?, 0, 0);
assert_eq!(event.previous_uri(), None);Sourcepub fn with_previous_uri(self, previous_uri: FileUri) -> Self
pub fn with_previous_uri(self, previous_uri: FileUri) -> Self
Attaches the entry’s former URI.
The value is accepted for every event kind and replaces an earlier one.
§Examples
use ailloli_ui_fs::{FileUri, WatchEvent, WatchEventKind};
let event = WatchEvent::new(WatchEventKind::Renamed, FileUri::parse("file:///new")?, 1, 1)
.with_previous_uri(FileUri::parse("file:///old")?);
assert_eq!(event.previous_uri().unwrap().path(), "/old");Sourcepub fn with_identity(self, identity: FileIdentity) -> Self
pub fn with_identity(self, identity: FileIdentity) -> Self
Attaches a provider-stable identity, replacing any previous identity.
§Examples
use ailloli_ui_fs::{FileIdentity, FileUri, WatchEvent, WatchEventKind};
let event = WatchEvent::new(WatchEventKind::Created, FileUri::parse("file:///a")?, 1, 1)
.with_identity(FileIdentity::new("local", [1]));
assert_eq!(event.identity().unwrap().value(), &[1]);Sourcepub const fn kind(&self) -> WatchEventKind
pub const fn kind(&self) -> WatchEventKind
Returns the normalized event category.
§Examples
use ailloli_ui_fs::{FileUri, WatchEvent, WatchEventKind};
let event = WatchEvent::new(WatchEventKind::Overflow, FileUri::parse("file:///")?, 1, 1);
assert_eq!(event.kind(), WatchEventKind::Overflow);Sourcepub const fn uri(&self) -> &FileUri
pub const fn uri(&self) -> &FileUri
Borrows the entry’s current/event URI.
§Examples
use ailloli_ui_fs::{FileUri, WatchEvent, WatchEventKind};
let event = WatchEvent::new(WatchEventKind::Removed, FileUri::parse("file:///a")?, 1, 1);
assert_eq!(event.uri().path(), "/a");Sourcepub const fn previous_uri(&self) -> Option<&FileUri>
pub const fn previous_uri(&self) -> Option<&FileUri>
Borrows the former URI, or returns None when it was not supplied.
§Examples
use ailloli_ui_fs::{FileUri, WatchEvent, WatchEventKind};
let event = WatchEvent::new(WatchEventKind::Created, FileUri::parse("file:///a")?, 1, 1);
assert!(event.previous_uri().is_none());Sourcepub const fn sequence(&self) -> u64
pub const fn sequence(&self) -> u64
Returns the provider sequence number within its generation.
§Examples
use ailloli_ui_fs::{FileUri, WatchEvent, WatchEventKind};
let event = WatchEvent::new(WatchEventKind::Created, FileUri::parse("file:///a")?, 7, 2);
assert_eq!(event.sequence(), 7);Sourcepub const fn generation(&self) -> u64
pub const fn generation(&self) -> u64
Returns the provider watch-generation identifier.
§Examples
use ailloli_ui_fs::{FileUri, WatchEvent, WatchEventKind};
let event = WatchEvent::new(WatchEventKind::Created, FileUri::parse("file:///a")?, 7, 2);
assert_eq!(event.generation(), 2);Sourcepub const fn identity(&self) -> Option<&FileIdentity>
pub const fn identity(&self) -> Option<&FileIdentity>
Borrows the stable identity, or returns None when unavailable.
§Examples
use ailloli_ui_fs::{FileUri, WatchEvent, WatchEventKind};
let event = WatchEvent::new(WatchEventKind::Created, FileUri::parse("file:///a")?, 1, 1);
assert!(event.identity().is_none());Trait Implementations§
Source§impl Clone for WatchEvent
impl Clone for WatchEvent
Source§fn clone(&self) -> WatchEvent
fn clone(&self) -> WatchEvent
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read more