GtkSourceView 5

https://world.pages.gitlab.gnome.org/Rust/sourceview5-rs/stable/latest/docs/
Admin
GtkSourceView 5 is a Rust library providing safe bindings for the GtkSourceView widget used in text...
Tokens:4,846,274
Snippets:25,661
Trust Score:10
Update:6 months ago
Show doc for...
Tokens:
Raw
### Start Mountable

Source: https://world.pages.gitlab.gnome.org/Rust/sourceview5-rs/stable/latest/docs/sourceview5/prelude/trait.FileExt.html?search=std%3A%3Avec

Starts a mountable drive, with asynchronous callback support.

```APIDOC
## POST /start_mountable

### Description
Starts a mountable drive. This operation can be cancelled and uses a callback for completion notification.

### Method
POST

### Endpoint
/start_mountable

### Parameters
#### Path Parameters
- **flags** (DriveStartFlags) - Required - Flags to control the starting behavior.
- **start_operation** (Option<&impl IsA<MountOperation>>) - Optional - A mount operation object to provide context.
- **cancellable** (Option<&impl IsA<Cancellable>>) - Optional - A cancellable object to allow cancellation of the operation.
- **callback** (P) - Required - A closure to be called when the operation completes.

### Response
#### Success Response (200)
- **None** - Operation successful.

#### Error Response (Error)
- **Error** - An error occurred during the operation.
```

--------------------------------

### Start Mountable Future

Source: https://world.pages.gitlab.gnome.org/Rust/sourceview5-rs/stable/latest/docs/sourceview5/prelude/trait.FileExt.html?search=std%3A%3Avec

Starts a mountable drive and returns a future.

```APIDOC
## POST /start_mountable_future

### Description
Starts a mountable drive and returns a future that resolves when the operation is complete.

### Method
POST

### Endpoint
/start_mountable_future

### Parameters
#### Path Parameters
- **flags** (DriveStartFlags) - Required - Flags to control the starting behavior.
- **start_operation** (Option<&(impl IsA<MountOperation> + Clone + 'static)>) - Optional - A mount operation object to provide context.

### Response
#### Success Response (200)
- **None** - Operation successful.

#### Error Response (Error)
- **Error** - An error occurred during the operation.
```

--------------------------------

### Start Mountable (Async)

Source: https://world.pages.gitlab.gnome.org/Rust/sourceview5-rs/stable/latest/docs/sourceview5/prelude/trait.FileExt.html

Starts a mountable drive asynchronously. Requires drive start flags, an optional mount operation, an optional cancellable object, and a callback for completion.

```rust
fn start_mountable<P>(
        &self,
        flags: DriveStartFlags,
        start_operation: Option<&impl IsA<MountOperation>>,
        cancellable: Option<&impl IsA<Cancellable>>,
        callback: P,
    )
       where P: FnOnce(Result<(), Error>) + 'static {
```

--------------------------------

### C Integration Example

Source: https://world.pages.gitlab.gnome.org/Rust/sourceview5-rs/stable/latest/docs/sourceview5/struct.VimIMContext.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Example of how to integrate VimIMContext with GtkSourceView using C.

```APIDOC
## C Integration Example

### Description
This example demonstrates how to set up a `GtkSourceView` with `VimIMContext` in C, including binding properties for command text display.

### Request Example
```c
GtkEventController *key;
GtkIMContext *im_context;
GtkWidget *view;

view = gtk_source_view_new ();
im_context = gtk_source_vim_im_context_new ();
key = gtk_event_controller_key_new ();

gtk_event_controller_key_set_im_context (GTK_EVENT_CONTROLLER_KEY (key), im_context);
gtk_event_controller_set_propagation_phase (key, GTK_PHASE_CAPTURE);
gtk_widget_add_controller (view, key);
gtk_im_context_set_client_widget (im_context, view);

g_object_bind_property (im_context, "command-bar-text", command_bar_label, "label", 0);
g_object_bind_property (im_context, "command-text", command_label, "label", 0);
```
```

--------------------------------

### C Integration Example

Source: https://world.pages.gitlab.gnome.org/Rust/sourceview5-rs/stable/latest/docs/sourceview5/struct.VimIMContext.html?search=std%3A%3Avec

Example of how to integrate VimIMContext in a C application using GTK.

```APIDOC
## C Integration Example

### Description
This example demonstrates how to initialize and configure `VimIMContext` within a GTK application written in C.

### Code
```c
GtkEventController *key;
GtkIMContext *im_context;
GtkWidget *view;

view = gtk_source_view_new ();
im_context = gtk_source_vim_im_context_new ();
key = gtk_event_controller_key_new ();

gtk_event_controller_key_set_im_context (GTK_EVENT_CONTROLLER_KEY (key), im_context);
gtk_event_controller_set_propagation_phase (key, GTK_PHASE_CAPTURE);
gtk_widget_add_controller (view, key);
gtk_im_context_set_client_widget (im_context, view);

g_object_bind_property (im_context, "command-bar-text", command_bar_label, "label", 0);
g_object_bind_property (im_context, "command-text", command_label, "label", 0);
```
```

--------------------------------

### Example Searches

Source: https://world.pages.gitlab.gnome.org/Rust/sourceview5-rs/stable/latest/docs/sourceview5_sys/fn.gtk_source_search_context_backward_finish.html?search=

These are example search queries that can be used with the sourceview5 library.

```text
std::vec
```

```text
u32 -> bool
```

```text
Option<T>, (T -> U) -> Option<U>
```

--------------------------------

### Search Examples

Source: https://world.pages.gitlab.gnome.org/Rust/sourceview5-rs/stable/latest/docs/src/sourceview5/auto/hover.rs.html?search=

Provides example search queries for the sourceview5-rs crate.

```APIDOC
### Search Examples

Example searches:

* `std::vec`
* `u32 -> bool`
* `Option<T>, (T -> U) -> Option<U>`
```

--------------------------------

### Python Integration Example

Source: https://world.pages.gitlab.gnome.org/Rust/sourceview5-rs/stable/latest/docs/sourceview5/struct.VimIMContext.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Example of how to integrate VimIMContext with GtkSourceView using Python.

```APIDOC
## Python Integration Example

### Description
This example demonstrates how to set up a `GtkSourceView` with `VimIMContext` in Python, including binding properties for command text display.

### Request Example
```python
key = Gtk.EventControllerKey.new()
im_context = GtkSource.VimIMContext.new()
buffer = GtkSource.Buffer()
view = GtkSource.View.new_with_buffer(buffer)

key.set_im_context(im_context)
key.set_propagation_phase(Gtk.PropagationPhase.CAPTURE)
view.add_controller(key)
im_context.set_client_widget(view)

im_context.bind_property(
    source_property="command-text",
    target=command_label,
    target_property="label",
    flags=GObject.BindingFlags.DEFAULT,
)

im_context.bind_property(
    source_property="command-bar-text",
    target=command_bar_label,
    target_property="label",
    flags=GObject.BindingFlags.DEFAULT,
)
```
```

--------------------------------

### Start Mountable Drive Asynchronously

Source: https://world.pages.gitlab.gnome.org/Rust/sourceview5-rs/stable/latest/docs/sourceview5/prelude/trait.FileExt.html?search=u32+-%3E+bool

Starts a mountable drive asynchronously using a callback.

```APIDOC
## POST /api/drives/{id}/start/async

### Description
Starts a mountable drive asynchronously using a callback.

### Method
POST

### Endpoint
/api/drives/{id}/start/async

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the mountable drive.

#### Request Body
- **flags** (DriveStartFlags) - Required - Flags for starting the drive.
- **start_operation** (MountOperation) - Optional - Operation details for starting.
- **cancellable** (Cancellable) - Optional - An object to control cancellation.
- **callback** (function) - Required - A callback function to be executed upon completion.
```

--------------------------------

### Example Search: std::vec

Source: https://world.pages.gitlab.gnome.org/Rust/sourceview5-rs/stable/latest/docs/sourceview5/prelude/trait.DeviceExt.html?search=

Demonstrates an example search query for 'std::vec'.

```text
std::vec
```

--------------------------------

### Python Integration Example

Source: https://world.pages.gitlab.gnome.org/Rust/sourceview5-rs/stable/latest/docs/sourceview5/struct.VimIMContext.html?search=std%3A%3Avec

Example of how to integrate VimIMContext in a Python application using PyGObject.

```APIDOC
## Python Integration Example

### Description
This example demonstrates how to initialize and configure `VimIMContext` within a GTK application written in Python using PyGObject.

### Code
```python
key = Gtk.EventControllerKey.new()
im_context = GtkSource.VimIMContext.new()
buffer = GtkSource.Buffer()
view = GtkSource.View.new_with_buffer(buffer)

key.set_im_context(im_context)
key.set_propagation_phase(Gtk.PropagationPhase.CAPTURE)
view.add_controller(key)
im_context.set_client_widget(view)

im_context.bind_property(
    source_property="command-text",
    target=command_label,
    target_property="label",
    flags=GObject.BindingFlags.DEFAULT,
)

im_context.bind_property(
    source_property="command-bar-text",
    target=command_bar_label,
    target_property="label",
    flags=GObject.BindingFlags.DEFAULT,
)
```
```

--------------------------------

### start Method

Source: https://world.pages.gitlab.gnome.org/Rust/sourceview5-rs/stable/latest/docs/sourceview5/prelude/trait.SocketServiceExt.html

Starts the socket service. This is a provided method within the SocketServiceExt trait.

```rust
fn start(&self) { ... }
```

--------------------------------

### Get Start Region Iterator - Rust Sourceview5

Source: https://world.pages.gitlab.gnome.org/Rust/sourceview5-rs/stable/latest/docs/sourceview5_sys/fn.gtk_source_region_get_start_region_iter.html

This function retrieves the start iterator for a given region. It is an unsafe external C function.

```rust
pub unsafe extern "C" fn gtk_source_region_get_start_region_iter(
    region: *mut GtkSourceRegion,
    iter: *mut GtkSourceRegionIter,
)
```

--------------------------------

### Initialize VimIMContext in C and Python

Source: https://world.pages.gitlab.gnome.org/Rust/sourceview5-rs/stable/latest/docs/src/sourceview5/auto/vim_im_context.rs.html?search=u32+-%3E+bool

Examples showing how to set up the VimIMContext with a GtkSourceView and bind command properties to UI labels.

```c
GtkEventController *key;
GtkIMContext *im_context;
GtkWidget *view;

view = gtk_source_view_new ();
im_context = gtk_source_vim_im_context_new ();
key = gtk_event_controller_key_new ();

gtk_event_controller_key_set_im_context (GTK_EVENT_CONTROLLER_KEY (key), im_context);
gtk_event_controller_set_propagation_phase (key, GTK_PHASE_CAPTURE);
gtk_widget_add_controller (view, key);
gtk_im_context_set_client_widget (im_context, view);

g_object_bind_property (im_context, "command-bar-text", command_bar_label, "label", 0);
g_object_bind_property (im_context, "command-text", command_label, "label", 0);
```

```python
key = Gtk.EventControllerKey.new()
im_context = GtkSource.VimIMContext.new()
buffer = GtkSource.Buffer()
view = GtkSource.View.new_with_buffer(buffer)

key.set_im_context(im_context)
key.set_propagation_phase(Gtk.PropagationPhase.CAPTURE)
view.add_controller(key)
im_context.set_client_widget(view)

im_context.bind_property(
    source_property="command-text",
    target=command_label,
    target_property="label",
    flags=GObject.BindingFlags.DEFAULT,
)

im_context.bind_property(
    source_property="command-bar-text",
    target=command_bar_label,
    target_property="label",
    flags=GObject.BindingFlags.DEFAULT,
)
```

--------------------------------

### Get Occurrence Position - Rust

Source: https://world.pages.gitlab.gnome.org/Rust/sourceview5-rs/stable/latest/docs/sourceview5_sys/fn.gtk_source_search_context_get_occurrence_position.html?search=

This function retrieves the start and end positions of a search occurrence. It requires a mutable GtkSourceSearchContext and pointers to GtkTextIter for the match start and end.

```rust
pub unsafe extern "C" fn gtk_source_search_context_get_occurrence_position(
    search: *mut GtkSourceSearchContext,
    match_start: *const GtkTextIter,
    match_end: *const GtkTextIter,
) -> c_int
```

--------------------------------

### VimIMContext Initialization (C)

Source: https://world.pages.gitlab.gnome.org/Rust/sourceview5-rs/stable/latest/docs/src/sourceview5/auto/vim_im_context.rs.html?search=std%3A%3Avec

Example of how to initialize and configure VimIMContext in C.

```APIDOC
## Initialize VimIMContext (C)

### Description

This C code snippet demonstrates how to create a `VimIMContext`, associate it with a `GtkSourceView`, and bind its command text properties to labels.

### Code Example

```c
GtkEventController *key;
GtkIMContext *im_context;
GtkWidget *view;

view = gtk_source_view_new ();
im_context = gtk_source_vim_im_context_new ();
key = gtk_event_controller_key_new ();

gtk_event_controller_key_set_im_context (GTK_EVENT_CONTROLLER_KEY (key), im_context);
gtk_event_controller_set_propagation_phase (key, GTK_PHASE_CAPTURE);
gtk_widget_add_controller (view, key);
gtk_im_context_set_client_widget (im_context, view);

g_object_bind_property (im_context, "command-bar-text", command_bar_label, "label", 0);
g_object_bind_property (im_context, "command-text", command_label, "label", 0);
```
```

--------------------------------

### VimIMContext Initialization (Python)

Source: https://world.pages.gitlab.gnome.org/Rust/sourceview5-rs/stable/latest/docs/src/sourceview5/auto/vim_im_context.rs.html?search=std%3A%3Avec

Example of how to initialize and configure VimIMContext in Python.

```APIDOC
## Initialize VimIMContext (Python)

### Description

This Python code snippet demonstrates how to create a `VimIMContext`, associate it with a `GtkSourceView`, and bind its command text properties to labels.

### Code Example

```python
key = Gtk.EventControllerKey.new()
im_context = GtkSource.VimIMContext.new()
buffer = GtkSource.Buffer()
view = GtkSource.View.new_with_buffer(buffer)

key.set_im_context(im_context)
key.set_propagation_phase(Gtk.PropagationPhase.CAPTURE)
view.add_controller(key)
im_context.set_client_widget(view)

im_context.bind_property(
    source_property="command-text",
    target=command_label,
    target_property="label",
    flags=GObject.BindingFlags.DEFAULT,
)

im_context.bind_property(
    source_property="command-bar-text",
    target=command_bar_label,
    target_property="label",
    flags=GObject.BindingFlags.DEFAULT,
)
```
```

--------------------------------

### GET /forward

Source: https://world.pages.gitlab.gnome.org/Rust/sourceview5-rs/stable/latest/docs/sourceview5/struct.SearchContext.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Performs a synchronous forward search in the buffer starting from the provided iterator.

```APIDOC
## GET /forward

### Description
Synchronous forward search. It is recommended to use the asynchronous functions instead, to not block the user interface.

### Method
GET

### Parameters
#### Path Parameters
- **iter** (TextIter) - Required - Start of search.

### Response
#### Success Response (200)
- **match_start** (TextIter) - Location for start of match, or None.
- **match_end** (TextIter) - Location for end of match, or None.
- **has_wrapped_around** (bool) - Location to know whether the search has wrapped around, or None.
```

--------------------------------

### Get Sourceview Minor Version

Source: https://world.pages.gitlab.gnome.org/Rust/sourceview5-rs/stable/latest/docs/src/sourceview5_sys/lib.rs.html?search=u32+-%3E+bool

Retrieves the minor version number of the installed Sourceview library.

```rust
pub fn gtk_source_get_minor_version() -> c_uint;
```

--------------------------------

### begin Method

Source: https://world.pages.gitlab.gnome.org/Rust/sourceview5-rs/stable/latest/docs/sourceview5/subclass/gutter_renderer/trait.GutterRendererImpl.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Called at the beginning of a gutter rendering cycle. Use this to initialize any state required for the current rendering pass.

```rust
fn begin(&self, lines: &GutterLines) { ... }
```

--------------------------------

### Get Sourceview Micro Version

Source: https://world.pages.gitlab.gnome.org/Rust/sourceview5-rs/stable/latest/docs/src/sourceview5_sys/lib.rs.html?search=u32+-%3E+bool

Retrieves the micro version number of the installed Sourceview library.

```rust
pub fn gtk_source_get_micro_version() -> c_uint;
```

--------------------------------

### Get Sourceview Major Version

Source: https://world.pages.gitlab.gnome.org/Rust/sourceview5-rs/stable/latest/docs/src/sourceview5_sys/lib.rs.html?search=u32+-%3E+bool

Retrieves the major version number of the installed Sourceview library.

```rust
pub fn gtk_source_get_major_version() -> c_uint;
```

--------------------------------

### Initialize VimIMContext in C

Source: https://world.pages.gitlab.gnome.org/Rust/sourceview5-rs/stable/latest/docs/sourceview5/struct.VimIMContext.html

Setup VimIMContext with a GtkSourceView and bind command display properties in C.

```c
GtkEventController *key;
GtkIMContext *im_context;
GtkWidget *view;

view = gtk_source_view_new ();
im_context = gtk_source_vim_im_context_new ();
key = gtk_event_controller_key_new ();

gtk_event_controller_key_set_im_context (GTK_EVENT_CONTROLLER_KEY (key), im_context);
gtk_event_controller_set_propagation_phase (key, GTK_PHASE_CAPTURE);
gtk_widget_add_controller (view, key);
gtk_im_context_set_client_widget (im_context, view);

g_object_bind_property (im_context, "command-bar-text", command_bar_label, "label", 0);
g_object_bind_property (im_context, "command-text", command_label, "label", 0);
```

--------------------------------

### Get bounds from GtkSourceHoverContext

Source: https://world.pages.gitlab.gnome.org/Rust/sourceview5-rs/stable/latest/docs/sourceview5_sys/fn.gtk_source_hover_context_get_bounds.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Retrieves the start and end bounds of the hover context using raw pointers.

```rust
pub unsafe extern "C" fn gtk_source_hover_context_get_bounds(
    self_: *mut GtkSourceHoverContext,
    begin: *mut GtkTextIter,
    end: *mut GtkTextIter,
) -> gboolean
```

--------------------------------

### Get Line Y-Range

Source: https://world.pages.gitlab.gnome.org/Rust/sourceview5-rs/stable/latest/docs/sourceview5/struct.Map.html?search=std%3A%3Avec

Calculates the vertical range (start y, end y) occupied by the line containing the given TextIter.

```rust
fn line_yrange(&self, iter: &TextIter) -> (i32, i32)
```

--------------------------------

### Implement begin method

Source: https://world.pages.gitlab.gnome.org/Rust/sourceview5-rs/stable/latest/docs/sourceview5/subclass/gutter_renderer/trait.GutterRendererImpl.html?search=

Lifecycle method called at the beginning of the rendering process.

```rust
fn begin(&self, lines: &GutterLines)
```

--------------------------------

### Get Buffer Bounds

Source: https://world.pages.gitlab.gnome.org/Rust/sourceview5-rs/stable/latest/docs/sourceview5/prelude/trait.TextBufferExt.html

Returns the start and end iterators representing the entire text buffer. This is useful for iterating over all content.

```rust
fn bounds(&self) -> (TextIter, TextIter)
```

--------------------------------

### Start Drive (Callback)

Source: https://world.pages.gitlab.gnome.org/Rust/sourceview5-rs/stable/latest/docs/sourceview5/prelude/trait.DriveExt.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Initiates the starting of the drive, with options for flags, a mount operation, and a cancellable object. A callback handles the operation's result.

```rust
fn start<P>(
        &self,
        flags: DriveStartFlags,
        mount_operation: Option<&impl IsA<MountOperation>>,
        cancellable: Option<&impl IsA<Cancellable>>,
        callback: P,
    )
       where P: FnOnce(Result<(), Error>) + 'static { ... }
```

--------------------------------

### Get Drive Start/Stop Type

Source: https://world.pages.gitlab.gnome.org/Rust/sourceview5-rs/stable/latest/docs/sourceview5/prelude/trait.DriveExt.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Returns the `DriveStartStopType` enum value, indicating how the drive is managed regarding starting and stopping.

```rust
fn start_stop_type(&self) -> DriveStartStopType { ... }
```

--------------------------------

### Sourceview5 Prelude CompletionProviderExt Method

Source: https://world.pages.gitlab.gnome.org/Rust/sourceview5-rs/stable/latest/docs/sourceview5/enum.SmartHomeEndType.html?search=u32+-%3E+bool

Documentation for the key_activates method of CompletionProviderExt in Sourceview5 prelude.

```APIDOC
## CompletionProviderExt::key_activates

### Description
Determines if a typed key should activate a completion proposal.

### Method
GET

### Endpoint
/sourceview5/prelude/completionproviderext/key_activates

### Parameters
#### Query Parameters
- **context** (CompletionContext) - Required - The completion context.
- **proposal** (IsA<CompletionProposal>) - Required - The completion proposal.
- **key_val** (u32) - Required - The key value typed.
- **modifier_type** (ModifierType) - Required - The modifier keys pressed.

### Response
#### Success Response (200)
- **result** (bool) - True if the key activates the proposal, false otherwise.
```

--------------------------------

### Get Subregion from RegionIter

Source: https://world.pages.gitlab.gnome.org/Rust/sourceview5-rs/stable/latest/docs/src/sourceview5/region_iter.rs.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Retrieves the start and end TextIter for the current subregion. Returns false if the iterator is at the end or the region is empty.

```rust
pub fn subregion(&mut self, start: &mut gtk::TextIter, end: &mut gtk::TextIter) -> bool {
        unsafe {
            from_glib(ffi::gtk_source_region_iter_get_subregion(
                self.to_glib_none_mut().0,
                start.to_glib_none_mut().0,
                end.to_glib_none_mut().0,
            ))
        }
    }
```

--------------------------------

### Get the start iterator of a Region

Source: https://world.pages.gitlab.gnome.org/Rust/sourceview5-rs/stable/latest/docs/src/sourceview5/auto/region.rs.html

Initializes a `RegionIter` to the first subregion of the `Region`. If the region is empty, the iterator will be set to the end iterator.

```rust
fn start_region_iter(&self) -> RegionIter {
    unsafe {
        let mut iter = RegionIter::uninitialized();
        ffi::gtk_source_region_get_start_region_iter(
            self.as_ref().to_glib_none().0,
            iter.to_glib_none_mut().0,
        );
        iter
    }
}

```

--------------------------------

### Get the bounds of a Region

Source: https://world.pages.gitlab.gnome.org/Rust/sourceview5-rs/stable/latest/docs/src/sourceview5/auto/region.rs.html

Retrieves the start and end `TextIter`ators defining the bounds of the `Region`. Returns `None` if the region is empty.

```rust
fn bounds(&self) -> Option<(gtk::TextIter, gtk::TextIter)> {
    unsafe {
        let mut start = gtk::TextIter::uninitialized();
        let mut end = gtk::TextIter::uninitialized();
        let ret = from_glib(ffi::gtk_source_region_get_bounds(
            self.as_ref().to_glib_none().0,
            start.to_glib_none_mut().0,
            end.to_glib_none_mut().0,
        ));
        if ret { Some((start, end)) } else { None }
    }
}

```

--------------------------------

### Initialize VimIMContext in Python

Source: https://world.pages.gitlab.gnome.org/Rust/sourceview5-rs/stable/latest/docs/sourceview5/struct.VimIMContext.html

Setup VimIMContext with a GtkSourceView and bind command display properties in Python.

```python
key = Gtk.EventControllerKey.new()
im_context = GtkSource.VimIMContext.new()
buffer = GtkSource.Buffer()
view = GtkSource.View.new_with_buffer(buffer)

key.set_im_context(im_context)
key.set_propagation_phase(Gtk.PropagationPhase.CAPTURE)
view.add_controller(key)
im_context.set_client_widget(view)

im_context.bind_property(
    source_property="command-text",
    target=command_label,
    target_property="label",
    flags=GObject.BindingFlags.DEFAULT,
)

im_context.bind_property(
    source_property="command-bar-text",
    target=command_bar_label,
    target_property="label",
    flags=GObject.BindingFlags.DEFAULT,
)
```

--------------------------------

### Get Bounds of GtkSourceRegion

Source: https://world.pages.gitlab.gnome.org/Rust/sourceview5-rs/stable/latest/docs/sourceview5_sys/fn.gtk_source_region_get_bounds.html?search=std%3A%3Avec

This function retrieves the start and end bounds of a GtkSourceRegion. It requires mutable pointers to GtkTextIter to store the results.

```rust
pub unsafe extern "C" fn gtk_source_region_get_bounds(
    region: *mut GtkSourceRegion,
    start: *mut GtkTextIter,
    end: *mut GtkTextIter,
) -> gboolean
```

--------------------------------

### Start Mountable (Future)

Source: https://world.pages.gitlab.gnome.org/Rust/sourceview5-rs/stable/latest/docs/sourceview5/prelude/trait.FileExt.html

Starts a mountable drive and returns a future. This is suitable for non-blocking drive startup operations.

```rust
fn start_mountable_future(
        &self,
        flags: DriveStartFlags,
        start_operation: Option<&(impl IsA<MountOperation> + Clone + 'static)>,
    ) -> Pin<Box<dyn Future<Output = Result<(), Error>>>>
```

--------------------------------

### Get Subregion from RegionIter

Source: https://world.pages.gitlab.gnome.org/Rust/sourceview5-rs/stable/latest/docs/sourceview5/struct.RegionIter.html

Retrieves the subregion at the current iterator position. Returns true if start and end iterators are successfully set.

```rust
pub fn subregion(&mut self, start: &mut TextIter, end: &mut TextIter) -> bool
```

--------------------------------

### Example Search: u32 to bool

Source: https://world.pages.gitlab.gnome.org/Rust/sourceview5-rs/stable/latest/docs/sourceview5/prelude/trait.DeviceExt.html?search=

Demonstrates an example search query for converting 'u32' to 'bool'.

```text
u32 -> bool
```

--------------------------------

### EditableExt: selection_bound

Source: https://world.pages.gitlab.gnome.org/Rust/sourceview5-rs/stable/latest/docs/sourceview5/prelude/trait.EditableExt.html?search=

Gets the current selection bound (start or end of selection) within the editable widget. This is a single integer value.

```rust
fn selection_bound(&self) -> i32
```

--------------------------------

### Start Mountable Drive (Future)

Source: https://world.pages.gitlab.gnome.org/Rust/sourceview5-rs/stable/latest/docs/sourceview5/prelude/trait.FileExt.html?search=u32+-%3E+bool

Starts a mountable drive and returns a future for asynchronous handling.

```APIDOC
## POST /api/drives/{id}/start/future

### Description
Starts a mountable drive and returns a future for asynchronous handling.

### Method
POST

### Endpoint
/api/drives/{id}/start/future

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the mountable drive.

#### Request Body
- **flags** (DriveStartFlags) - Required - Flags for starting the drive.
- **start_operation** (MountOperation) - Optional - Operation details for starting.
```

--------------------------------

### Get Bounds of Source Region

Source: https://world.pages.gitlab.gnome.org/Rust/sourceview5-rs/stable/latest/docs/sourceview5/prelude/trait.RegionExt.html

Retrieves the start and end TextIterators defining the bounds of the current region. Returns false if the region is empty.

```rust
fn bounds(&self) -> Option<(TextIter, TextIter)> { ... }
```

--------------------------------

### Get Hover Context Bounds in Rust

Source: https://world.pages.gitlab.gnome.org/Rust/sourceview5-rs/stable/latest/docs/src/sourceview5/auto/hover_context.rs.html?search=u32+-%3E+bool

Retrieves the start and end text iterators for the word currently being hovered over. Returns `None` if the marks are not valid.

```rust
impl HoverContext {
    /// Gets the current word bounds of the hover.
    ///
    /// If @begin is non-[`None`], it will be set to the start position of the
    /// current word being hovered.
    ///
    /// If @end is non-[`None`], it will be set to the end position for the
    /// current word being hovered.
    ///
    /// # Returns
    ///
    /// [`true`] if the marks are still valid and @begin or @end was set.
    ///
    /// ## `begin`
    /// a #GtkTextIter
    ///
    /// ## `end`
    /// a #GtkTextIter
    #[doc(alias = "gtk_source_hover_context_get_bounds")]
    #[doc(alias = "get_bounds")]
    pub fn bounds(&self) -> Option<(gtk::TextIter, gtk::TextIter)> {
        unsafe {
            let mut begin = gtk::TextIter::uninitialized();
            let mut end = gtk::TextIter::uninitialized();
            let ret = from_glib(ffi::gtk_source_hover_context_get_bounds(
                self.to_glib_none().0,
                begin.to_glib_none_mut().0,
                end.to_glib_none_mut().0,
            ));
            if ret { Some((begin, end)) } else { None }
        }
    }
// ... other methods
```

--------------------------------

### Get Visible Range of Rows

Source: https://world.pages.gitlab.gnome.org/Rust/sourceview5-rs/stable/latest/docs/sourceview5/prelude/trait.TreeViewExt.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Returns the range of rows (start and end TreePath) that are currently visible in the viewport. Returns None if no rows are visible.

```rust
    fn visible_range(&self) -> Option<(TreePath, TreePath)> { ... }

```

--------------------------------

### Get Hover Context Bounds

Source: https://world.pages.gitlab.gnome.org/Rust/sourceview5-rs/stable/latest/docs/src/sourceview5/auto/hover_context.rs.html

Retrieves the start and end text iterators for the word currently being hovered over. Returns true if the marks are valid and iterators were set.

```rust
/// Gets the current word bounds of the hover.
///
/// If @begin is non-[`None`], it will be set to the start position of the
/// current word being hovered.
///
/// If @end is non-[`None`], it will be set to the end position for the
/// current word being hovered.
///
/// # Returns
///
/// [`true`] if the marks are still valid and @begin or @end was set.
///
/// ## `begin`
/// a #GtkTextIter
///
/// ## `end`
/// a #GtkTextIter
#[doc(alias = "gtk_source_hover_context_get_bounds")]
#[doc(alias = "get_bounds")]
pub fn bounds(&self) -> Option<(gtk::TextIter, gtk::TextIter)> {
    unsafe {
        let mut begin = gtk::TextIter::uninitialized();
        let mut end = gtk::TextIter::uninitialized();
        let ret = from_glib(ffi::gtk_source_hover_context_get_bounds(
            self.to_glib_none().0,
            begin.to_glib_none_mut().0,
            end.to_glib_none_mut().0,
        ));
        if ret { Some((begin, end)) } else { None }
    }
}
```

--------------------------------

### Launch Application with Files

Source: https://world.pages.gitlab.gnome.org/Rust/sourceview5-rs/stable/latest/docs/sourceview5/prelude/trait.AppInfoExt.html?search=std%3A%3Avec

Launches the application with a list of files. Requires a slice of File objects and an optional AppLaunchContext.

```rust
fn launch(
        &self,
        files: &[File],
        context: Option<&impl IsA<AppLaunchContext>>,
    ) -> Result<(), Error> { ... }
```

--------------------------------

### Get CompletionContext bounds

Source: https://world.pages.gitlab.gnome.org/Rust/sourceview5-rs/stable/latest/docs/src/sourceview5/auto/completion_context.rs.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Retrieves the start and end positions of the word currently being completed within the view's buffer. Useful for highlighting or manipulating the text.

```rust
/// Gets the bounds for the completion, which is the beginning of the
    /// current word (taking break characters into account) to the current
    /// insertion cursor.
    ///
    /// If @begin is non-[`None`], it will be set to the start position of the
    /// current word being completed.
    ///
    /// If @end is non-[`None`], it will be set to the insertion cursor for the
    /// current word being completed.
    ///
    /// # Returns
```

--------------------------------

### GdkAppLaunchContextExt Methods

Source: https://world.pages.gitlab.gnome.org/Rust/sourceview5-rs/stable/latest/docs/sourceview5/prelude/trait.GdkAppLaunchContextExt.html

Methods available for interacting with and configuring an AppLaunchContext.

```APIDOC
## GdkAppLaunchContextExt Methods

### Description
Provides functionality to manage application launch context properties such as display, desktop, icons, and timestamps.

### Methods
- **display() -> Display**: Returns the display associated with the context.
- **set_desktop(desktop: i32)**: Sets the desktop on which the application will be launched.
- **set_icon(icon: Option<&impl IsA<Icon>>)**: Sets the icon for the application launch.
- **set_icon_name(icon_name: Option<&str>)**: Sets the icon name for the application launch.
- **set_timestamp(timestamp: u32)**: Sets the timestamp for the application launch.
```

--------------------------------

### Option::as_slice Inverse Example

Source: https://world.pages.gitlab.gnome.org/Rust/sourceview5-rs/stable/latest/docs/sourceview5_sys/type.GtkSourceSchedulerCallback.html?search=

Demonstrates the inverse relationship between Option::as_slice and slice::first, showing how to get the first element of a slice derived from an Option.

```rust
for i in [Some(1234_u16), None] {
    assert_eq!(i.as_ref(), i.as_slice().first());
}

```

--------------------------------

### Get Last Visible Line

Source: https://world.pages.gitlab.gnome.org/Rust/sourceview5-rs/stable/latest/docs/src/sourceview5/auto/gutter_lines.rs.html

Returns the line number (starting from 0) of the last line that is currently visible to the user. This complements `first()` for defining the visible range.

```rust
/// Gets the line number (starting from 0) for the last line that is
/// user visible.
///
/// # Returns
///
/// a line number starting from 0
#[doc(alias = "gtk_source_gutter_lines_get_last")]
#[doc(alias = "get_last")]
pub fn last(&self) -> u32 {
    unsafe { ffi::gtk_source_gutter_lines_get_last(self.to_glib_none().0) }
}

```

--------------------------------

### Prelude Module

Source: https://world.pages.gitlab.gnome.org/Rust/sourceview5-rs/stable/latest/docs/src/sourceview5/subclass/mod.rs.html?search=

Provides blanket imports for common traits across various sourceview5 components.

```APIDOC
## Module `prelude`

### Description
Traits intended for blanket imports.

### Re-exported Traits
- `buffer::BufferImpl`
- `buffer::BufferImplExt`
- `completion_proposal::CompletionProposalImpl`
- `completion_provider::CompletionProviderImpl`
- `completion_provider::CompletionProviderImplExt`
- `gutter_renderer::GutterRendererImpl`
- `gutter_renderer::GutterRendererImplExt`
- `hover_provider::HoverProviderImpl`
- `hover_provider::HoverProviderImplExt`
- `indenter::IndenterImpl`
- `indenter::IndenterImplExt`
- `style_scheme_chooser::StyleSchemeChooserImpl`
- `style_scheme_chooser::StyleSchemeChooserImplExt`
- `view::ViewImpl`
- `view::ViewImplExt`
```

--------------------------------

### Get Completion Context Bounds

Source: https://world.pages.gitlab.gnome.org/Rust/sourceview5-rs/stable/latest/docs/sourceview5/struct.CompletionContext.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Retrieves the bounds for the completion, defining the start of the current word to the insertion cursor. Returns true if marks are valid and bounds were set.

```rust
pub fn bounds(&self) -> Option<(TextIter, TextIter)>
```

--------------------------------

### Sourceview5 CompletionProviderExt Method

Source: https://world.pages.gitlab.gnome.org/Rust/sourceview5-rs/stable/latest/docs/sourceview5/prelude/trait.DBusObjectManagerServerExt.html?search=u32+-%3E+bool

Documentation for the `key_activates` method of CompletionProviderExt in sourceview5.

```APIDOC
## Method sourceview5::prelude::CompletionProviderExt::key_activates

### Description
This function is used to determine if a key typed by the user should activate a completion proposal.

### Parameters
- `provider` (Self) - Required - The CompletionProviderExt instance.
- `context` (&CompletionContext) - Required - The completion context.
- `proposal` (&IsA<CompletionProposal>) - Required - The completion proposal.
- `key` (u32) - Required - The key code.
- `modifier_type` (ModifierType) - Required - The modifier keys pressed.

### Returns
- `bool` - True if the key press should activate the proposal, false otherwise.
```

--------------------------------

### Region Iteration Example (C)

Source: https://world.pages.gitlab.gnome.org/Rust/sourceview5-rs/stable/latest/docs/sourceview5/struct.Region.html?search=

Example demonstrating how to iterate through subregions of a GtkSourceRegion using C.

```APIDOC
### Region Iteration Example (C)

```c
GtkSourceRegion *region;
GtkSourceRegionIter region_iter;

gtk_source_region_get_start_region_iter (region, &region_iter);

while (!gtk_source_region_iter_is_end (&region_iter))
{
        GtkTextIter subregion_start;
        GtkTextIter subregion_end;

        if (!gtk_source_region_iter_get_subregion (&region_iter,
                                                   &subregion_start,
                                                   &subregion_end))
        {
                break;
        }

        // Do something useful with the subregion.

        gtk_source_region_iter_next (&region_iter);
}
```
```

--------------------------------

### Get First Visible Line

Source: https://world.pages.gitlab.gnome.org/Rust/sourceview5-rs/stable/latest/docs/src/sourceview5/auto/gutter_lines.rs.html

Returns the line number (starting from 0) of the first line that is currently visible to the user. This is useful for determining the visible range of the text buffer.

```rust
/// Gets the line number (starting from 0) for the first line that is
/// user visible.
///
/// # Returns
///
/// a line number starting from 0
#[doc(alias = "gtk_source_gutter_lines_get_first")]
#[doc(alias = "get_first")]
pub fn first(&self) -> u32 {
    unsafe { ffi::gtk_source_gutter_lines_get_first(self.to_glib_none().0) }
}

```

--------------------------------

### Get Last Visible Line Number

Source: https://world.pages.gitlab.gnome.org/Rust/sourceview5-rs/stable/latest/docs/sourceview5/struct.GutterLines.html?search=std%3A%3Avec

Returns the line number (starting from 0) of the last line that is currently visible to the user. This complements `first()` for defining the visible viewport.

```rust
pub fn last(&self) -> u32
```

--------------------------------

### Get First Visible Line Number

Source: https://world.pages.gitlab.gnome.org/Rust/sourceview5-rs/stable/latest/docs/sourceview5/struct.GutterLines.html?search=std%3A%3Avec

Returns the line number (starting from 0) of the first line that is currently visible to the user. This is useful for determining the visible range of the text.

```rust
pub fn first(&self) -> u32
```

--------------------------------

### Implement CompletionProvider Methods

Source: https://world.pages.gitlab.gnome.org/Rust/sourceview5-rs/stable/latest/docs/src/sourceview5/auto/completion_provider.rs.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Methods for activating proposals, displaying cells, and retrieving provider priority.

```rust
    fn activate(&self, context: &CompletionContext, proposal: &impl IsA<CompletionProposal>) {
        unsafe {
            ffi::gtk_source_completion_provider_activate(
                self.as_ref().to_glib_none().0,
                context.to_glib_none().0,
                proposal.as_ref().to_glib_none().0,
            );
        }
    }
```

```rust
    fn display(
        &self,
        context: &CompletionContext,
        proposal: &impl IsA<CompletionProposal>,
        cell: &CompletionCell,
    ) {
        unsafe {
            ffi::gtk_source_completion_provider_display(
                self.as_ref().to_glib_none().0,
                context.to_glib_none().0,
                proposal.as_ref().to_glib_none().0,
                cell.to_glib_none().0,
            );
        }
    }
```

```rust
    fn priority(&self, context: &CompletionContext) -> i32 {
        unsafe {
            ffi::gtk_source_completion_provider_get_priority(
                self.as_ref().to_glib_none().0,
                context.to_glib_none().0,
            )
        }
    }
```

--------------------------------

### Get Subregion from RegionIter

Source: https://world.pages.gitlab.gnome.org/Rust/sourceview5-rs/stable/latest/docs/src/sourceview5/region_iter.rs.html

Retrieves the current subregion defined by start and end TextIterators. Returns false if the iterator is at the end or the region is empty. Requires mutable access to the RegionIter and TextIterators.

```rust
impl RegionIter {
    /// Gets the subregion at this iterator.
    ///
    /// # Returns
    ///
    /// [`true`] if @start and @end have been set successfully (if non-[`None`]),
    ///   or [`false`] if @self is the end iterator or if the region is empty.
    ///
    /// ## `start`
    /// iterator to initialize with the subregion start, or [`None`].
    ///
    /// ## `end`
    /// iterator to initialize with the subregion end, or [`None`].
    #[doc(alias = "gtk_source_region_iter_get_subregion")]
    #[doc(alias = "get_subregion")]
    pub fn subregion(&mut self, start: &mut gtk::TextIter, end: &mut gtk::TextIter) -> bool {
        unsafe {
            from_glib(ffi::gtk_source_region_iter_get_subregion(
                self.to_glib_none_mut().0,
                start.to_glib_none_mut().0,
                end.to_glib_none_mut().0,
            ))
        }
    }
// ... other methods
```

--------------------------------

### Get Completion Context Bounds

Source: https://world.pages.gitlab.gnome.org/Rust/sourceview5-rs/stable/latest/docs/sourceview5_sys/fn.gtk_source_completion_context_get_bounds.html

Use this function to retrieve the start and end text iterators for the current completion context. It requires a mutable pointer to a GtkSourceCompletionContext and mutable pointers for the begin and end GtkTextIter.

```rust
pub unsafe extern "C" fn gtk_source_completion_context_get_bounds(
    self_: *mut GtkSourceCompletionContext,
    begin: *mut GtkTextIter,
    end: *mut GtkTextIter,
) -> gboolean
```

--------------------------------

### Sourceview5 Prelude CompletionProviderExt Methods

Source: https://world.pages.gitlab.gnome.org/Rust/sourceview5-rs/stable/latest/docs/sourceview5/prelude/trait.EditableExt.html?search=u32+-%3E+bool

Documentation for CompletionProviderExt methods in Sourceview5 prelude.

```APIDOC
## CompletionProviderExt::key_activates

### Description
Determines if a typed key should activate a completion proposal.

### Method
GET

### Endpoint
N/A (Method within a trait)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Response
#### Success Response (200)
- **bool** - True if the key activates completion, false otherwise.
```

--------------------------------

### Start a Drive Future in Sourceview5

Source: https://world.pages.gitlab.gnome.org/Rust/sourceview5-rs/stable/latest/docs/sourceview5/prelude/trait.DriveExt.html?search=u32+-%3E+bool

Asynchronously starts a drive operation. Use this for non-blocking start operations.

```rust
fn start_future(
    &self,
    flags: DriveStartFlags,
    mount_operation: Option<&(impl IsA<MountOperation> + Clone + 'static)ческой>
) -> Pin<Box<dyn Future<Output = Result<(), Error>>>>
```

--------------------------------

### Example Search: Option<T> transformation

Source: https://world.pages.gitlab.gnome.org/Rust/sourceview5-rs/stable/latest/docs/sourceview5/prelude/trait.DeviceExt.html?search=

Demonstrates an example search query for transforming 'Option<T>' to 'Option<U>' using a function from 'T' to 'U'.

```text
Option<T>, (T -> U) -> Option<U>
```

--------------------------------

### Example Searches

Source: https://world.pages.gitlab.gnome.org/Rust/sourceview5-rs/stable/latest/docs/sourceview5/prelude/trait.SourceFileExt.html?search=

Examples of search queries that can be performed.

```APIDOC
## Example Searches

Example searches:
  * std::vec
  * u32 -> bool
  * Option<T>, (T -> U) -> Option<U>
```

--------------------------------

### Property Get

Source: https://world.pages.gitlab.gnome.org/Rust/sourceview5-rs/stable/latest/docs/sourceview5/struct.FileSaver.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Methods for getting property values.

```APIDOC
## POST /property/get

### Description
Gets the value of a property, applying a function to it.

### Method
POST

### Endpoint
`/property/get`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **f** (function) - Required - A function to apply to the property value.

### Request Example
```json
{
  "f": "(value) => value.to_string()"
}
```

### Response
#### Success Response (200)
- **R** (any) - The result of applying the function to the property value.

#### Response Example
```json
{
  "result": "property_value_as_string"
}
```
```

--------------------------------

### Example Searches

Source: https://world.pages.gitlab.gnome.org/Rust/sourceview5-rs/stable/latest/docs/sourceview5/struct.CompletionContext.html?search=

These are example search queries demonstrating common patterns for searching within Rust codebases or documentation. They cover standard library types, type conversions, and generic Option transformations.

```rust
* std::vec
```

```rust
* u32 -> bool
```

```rust
* Option<T>, (T -> U) -> Option<U>
```

--------------------------------

### Start Drive (Future)

Source: https://world.pages.gitlab.gnome.org/Rust/sourceview5-rs/stable/latest/docs/sourceview5/prelude/trait.DriveExt.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Provides a future-based interface for starting a drive. It takes flags and an optional mount operation, returning a future that resolves to a Result.

```rust
fn start_future(
        &self,
        flags: DriveStartFlags,
        mount_operation: Option<&(impl IsA<MountOperation> + Clone + 'static)>,
    ) -> Pin<Box<dyn Future<Output = Result<(), Error>>>> { ... }
```

--------------------------------

### GET /hover

Source: https://world.pages.gitlab.gnome.org/Rust/sourceview5-rs/stable/latest/docs/src/sourceview5/auto/view.rs.html?search=

Gets the Hover object associated with the view.

```APIDOC
## GET /hover

### Description
Gets the Hover associated with the view. The returned object is guaranteed to be the same for the lifetime of the view.

### Response
#### Success Response (200)
- **return** (Hover) - The GtkSourceHover associated with the view.
```

--------------------------------

### GET /completion

Source: https://world.pages.gitlab.gnome.org/Rust/sourceview5-rs/stable/latest/docs/src/sourceview5/auto/view.rs.html?search=

Gets the Completion object associated with the view.

```APIDOC
## GET /completion

### Description
Gets the Completion associated with the view. The returned object is guaranteed to be the same for the lifetime of the view.

### Response
#### Success Response (200)
- **return** (Completion) - The GtkSourceCompletion associated with the view.
```

--------------------------------

### Sourceview5 Methods

Source: https://world.pages.gitlab.gnome.org/Rust/sourceview5-rs/stable/latest/docs/sourceview5_sys/fn.gtk_source_encoding_copy.html?search=u32+-%3E+bool

A collection of method signatures and brief descriptions from the sourceview5 crate.

```APIDOC
## Sourceview5 Methods

### GutterLines::is_cursor
Checks to see if @line contains the insertion cursor.

### GutterLines::is_prelit
Checks to see if @line is marked as prelit.

### GutterLines::is_selected
Checks to see if the view had a selection and if that line is part of it.

### SelectionModelExt::is_selected
Checks if a specific item is selected.

### GutterLines::has_any_class
Checks to see if the line has any GQuark classes set.

### check_version Function
Like GTK_SOURCE_CHECK_VERSION, but the check for the version is performed at runtime.

### SelectionModelExt::unselect_item
Unselects a specific item.

### GutterLines::has_qclass
Checks to see if `add_qclass()` was called with the quark.

### SelectionModelExt::select_item
Selects a specific item.

### SelectionModelExt::unselect_range
Unselects a range of items.

### GutterLines::has_class
Checks to see if `add_class()` was called with the @name for the line.

### SelectionModelExt::select_range
Selects a range of items.

### IndenterExt::is_trigger
This function is used to determine if a key pressed should trigger indentation.

### CompletionProviderExt::key_activates
This function is used to determine if a key typed by the user should activate a completion.

### IMContextExt::filter_key
Filters a key event within an Input Method context.
```

--------------------------------

### GET occurrences_count

Source: https://world.pages.gitlab.gnome.org/Rust/sourceview5-rs/stable/latest/docs/src/sourceview5/auto/search_context.rs.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Gets the total number of search occurrences.

```APIDOC
## GET occurrences_count

### Description
Gets the total number of search occurrences. Returns -1 if the buffer is not fully scanned.

### Method
GET

### Response
#### Success Response (200)
- **count** (i32) - The total number of search occurrences.
```
Tokens:
Raw