search

notify-rs / notify

🔭 Cross-platform filesystem notification library for Rust.
https://docs.rs/notify
2.76k stars 222 forks source link

Document `notify::event::EventAttributes::info` #619

Open bicarlsen opened 4 months ago

bicarlsen commented 4 months ago

It doesn't appear there is any documentation about what information notify::event::EventAttributes::info represents. e.g. What values are possible here? If info is Some("override"), what does this mean?

It seems there are only a few places info is set:

  1. https://github.com/notify-rs/notify/blob/128bf6230c03d39dbb7f301ff7b20e594e34c3a2/notify/src/fsevent.rs#L114
  2. https://github.com/notify-rs/notify/blob/128bf6230c03d39dbb7f301ff7b20e594e34c3a2/notify/src/fsevent.rs#L159
  3. https://github.com/notify-rs/notify/blob/128bf6230c03d39dbb7f301ff7b20e594e34c3a2/notify-debouncer-full/src/lib.rs#L469