Class: INotify::Event
- Defined in:
- lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rb-inotify-0.10.1/lib/rb-inotify/event.rb
Overview
An event caused by a change on the filesystem. Each Watcher can fire many events, which are passed to that watcher’s callback.
Instance Attribute Summary collapse
-
#cookie ⇒ Fixnum
readonly
An integer specifying that this event is related to some other event, which will have the same cookie.
-
#name ⇒ String
readonly
The name of the file that the event occurred on.
-
#notifier ⇒ Notifier
readonly
The Notifier that fired this event.
-
#related ⇒ Array<Event>
readonly
A list of other events that are related to this one.
- #watcher_id ⇒ Fixnum readonly
Class Method Summary collapse
-
.consume(data, notifier) ⇒ Event?
Constructs an Event object from a string of binary data, and destructively modifies the string to get rid of the initial segment used to construct the Event.
Instance Method Summary collapse
-
#absolute_name ⇒ String
The absolute path of the file that the event occurred on.
-
#callback! ⇒ Object
Calls the callback of the watcher that fired this event, passing in the event itself.
-
#flags ⇒ Array<Symbol>
Returns the flags that describe this event.
-
#initialize(data, notifier) ⇒ Event
constructor
Creates an event from a string of binary data.
-
#size ⇒ Fixnum
Returns the size of this event object in bytes, including the #name string.
-
#watcher ⇒ Watcher
Returns the Watcher that fired this event.
Constructor Details
#initialize(data, notifier) ⇒ Event
Creates an event from a string of binary data. Differs from consume in that it doesn’t modify the string.
111 112 113 114 115 116 117 118 119 120 121 |
# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rb-inotify-0.10.1/lib/rb-inotify/event.rb', line 111 def initialize(data, notifier) ptr = FFI::MemoryPointer.from_string(data) @native = Native::Event.new(ptr) @related = [] @cookie = @native[:cookie] @name = fix_encoding(data[@native.size, @native[:len]].gsub(/\0+$/, '')) @notifier = notifier @watcher_id = @native[:wd] raise QueueOverflowError.new("inotify event queue has overflowed.") if @native[:mask] & Native::Flags::IN_Q_OVERFLOW != 0 end |
Instance Attribute Details
#cookie ⇒ Fixnum (readonly)
An integer specifying that this event is related to some other event, which will have the same cookie.
Currently, this is only used for files that are moved within the same directory. Both the ‘:moved_from` and the `:moved_to` events will have the same cookie.
43 44 45 |
# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rb-inotify-0.10.1/lib/rb-inotify/event.rb', line 43 def @cookie end |
#name ⇒ String (readonly)
The name of the file that the event occurred on. This is only set for events that occur on files in directories; otherwise, it’s ‘“”`. Similarly, if the event is being fired for the directory itself the name will be `“”`
This pathname is relative to the enclosing directory. For the absolute pathname, use #absolute_name. Note that when the ‘:recursive` flag is passed to Notifier#watch, events in nested subdirectories will still have a `#name` field relative to their immediately enclosing directory. For example, an event on the file `“foo/bar/baz”` will have name `“baz”`.
28 29 30 |
# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rb-inotify-0.10.1/lib/rb-inotify/event.rb', line 28 def name @name end |
#notifier ⇒ Notifier (readonly)
The Notifier that fired this event.
33 34 35 |
# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rb-inotify-0.10.1/lib/rb-inotify/event.rb', line 33 def notifier @notifier end |
#related ⇒ Array<Event> (readonly)
A list of other events that are related to this one. Currently, this is only used for files that are moved within the same directory: the ‘:moved_from` and the `:moved_to` events will be related.
11 12 13 |
# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rb-inotify-0.10.1/lib/rb-inotify/event.rb', line 11 def @related end |
Class Method Details
.consume(data, notifier) ⇒ Event?
Constructs an INotify::Event object from a string of binary data, and destructively modifies the string to get rid of the initial segment used to construct the Event.
98 99 100 101 102 103 |
# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rb-inotify-0.10.1/lib/rb-inotify/event.rb', line 98 def self.consume(data, notifier) return nil if data.empty? ev = new(data, notifier) data.replace data[ev.size..-1] ev end |
Instance Method Details
#absolute_name ⇒ String
The absolute path of the file that the event occurred on.
This is actually only as absolute as the path passed to the Watcher that created this event. However, it is relative to the working directory, assuming that hasn’t changed since the watcher started.
66 67 68 69 |
# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rb-inotify-0.10.1/lib/rb-inotify/event.rb', line 66 def absolute_name return watcher.path if name.empty? return File.join(watcher.path, name) end |
#callback! ⇒ Object
Calls the callback of the watcher that fired this event, passing in the event itself.
127 128 129 |
# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rb-inotify-0.10.1/lib/rb-inotify/event.rb', line 127 def callback! watcher && watcher.callback!(self) end |
#flags ⇒ Array<Symbol>
Returns the flags that describe this event. This is generally similar to the input to Notifier#watch, except that it won’t contain options flags nor ‘:all_events`, and it may contain one or more of the following flags:
‘:unmount` : The filesystem containing the watched file or directory was unmounted.
‘:ignored` : The watcher was closed, or the watched file or directory was deleted.
‘:isdir` : The subject of this event is a directory.
86 87 88 |
# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rb-inotify-0.10.1/lib/rb-inotify/event.rb', line 86 def flags @flags ||= Native::Flags.from_mask(@native[:mask]) end |