Cosmic Text

https://pop-os.github.io/cosmic-text/cosmic_text
Admin
Cosmic Text is a Rust library providing advanced text handling with abstractions for shaping, font...
Tokens:314,832
Snippets:4,309
Trust Score:8.3
Update:5 months ago
Show doc for...
Tokens:
Raw
### Custom Fallback Implementation Example

Source: https://pop-os.github.io/cosmic-text/cosmic_text/fallback/trait.Fallback.html

Example of implementing the Fallback trait with custom font lists for different scripts and common fallbacks. This allows for fine-grained control over font selection.

```rust
struct MyFallback;
impl Fallback for MyFallback {
    fn common_fallback(&self) -> &[&'static str] {
        &[
            "Segoe UI",
            "Segoe UI Emoji",
            "Segoe UI Symbol",
            "Segoe UI Historic",
        ]
    }

    fn forbidden_fallback(&self) -> &[&'static str] {
        &[]
    }

    fn script_fallback(&self, script: Script, locale: &str) -> &[&'static str] {
        match script {
            Script::Adlam => &["Ebrima"],
            Script::Bengali => &["Nirmala UI"],
            Script::Canadian_Aboriginal => &["Gadugi"],
            // ...
            _ => &[],
       }
    }
}

let locale = "en-US".to_string();
let db = fontdb::Database::new();
let font_system = FontSystem::new_with_locale_and_db_and_fallback(locale, db, MyFallback);
```

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

### Example Implementation of Fallback Trait

Source: https://pop-os.github.io/cosmic-text/cosmic_text/fallback/trait.Fallback.html?search=u32+-%3E+bool

This example demonstrates how to implement the `Fallback` trait for a custom struct `MyFallback` and use it with `FontSystem`.

```APIDOC
```rust
struct MyFallback;
impl Fallback for MyFallback {
    fn common_fallback(&self) -> &[&'static str] {
        &[
            "Segoe UI",
            "Segoe UI Emoji",
            "Segoe UI Symbol",
            "Segoe UI Historic",
        ]
    }

    fn forbidden_fallback(&self) -> &[&'static str] {
        &[]
    }

    fn script_fallback(&self, script: Script, locale: &str) -> &[&'static str] {
        match script {
            Script::Adlam => &["Ebrima"],
            Script::Bengali => &["Nirmala UI"],
            Script::Canadian_Aboriginal => &["Gadugi"],
            // ...
            _ => &[],
       }
    }
}

let locale = "en-US".to_string();
let db = fontdb::Database::new();
let font_system = FontSystem::new_with_locale_and_db_and_fallback(locale, db, MyFallback);
```
```

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

### Example Implementation of Fallback Trait

Source: https://pop-os.github.io/cosmic-text/cosmic_text/fallback/trait.Fallback.html

This example demonstrates how to implement the `Fallback` trait for a custom fallback strategy. It defines common, forbidden, and script-specific fallbacks.

```APIDOC
```rust
struct MyFallback;

impl Fallback for MyFallback {
    fn common_fallback(&self) -> &[&'static str] {
        &[
            "Segoe UI",
            "Segoe UI Emoji",
            "Segoe UI Symbol",
            "Segoe UI Historic",
        ]
    }

    fn forbidden_fallback(&self) -> &[&'static str] {
        &[]
    }

    fn script_fallback(&self, script: Script, locale: &str) -> &[&'static str] {
        match script {
            Script::Adlam => &["Ebrima"],
            Script::Bengali => &["Nirmala UI"],
            Script::Canadian_Aboriginal => &["Gadugi"],
            // ...
            _ => &[],
       }
    }
}

let locale = "en-US".to_string();
let db = fontdb::Database::new();
let font_system = FontSystem::new_with_locale_and_db_and_fallback(locale, db, MyFallback);
```
```

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

### Buffer::hinting

Source: https://pop-os.github.io/cosmic-text/cosmic_text/struct.Buffer.html

Gets the current Hinting strategy.

```APIDOC
## Buffer::hinting

### Description
Get the current `Hinting` strategy.

### Method
`pub const fn hinting(&self) -> Hinting`
```

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

### Buffer::wrap

Source: https://pop-os.github.io/cosmic-text/cosmic_text/struct.Buffer.html

Gets the current Wrap setting.

```APIDOC
## Buffer::wrap

### Description
Get the current `Wrap`

### Method
`pub const fn wrap(&self) -> Wrap`
```

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

### Get Hinting Strategy

Source: https://pop-os.github.io/cosmic-text/cosmic_text/struct.Buffer.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Retrieves the current text hinting strategy.

```rust
pub const fn hinting(&self) -> Hinting
```

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

### Get Hinting Strategy

Source: https://pop-os.github.io/cosmic-text/cosmic_text/struct.Buffer.html

Retrieves the current font hinting strategy.

```rust
pub const fn hinting(&self) -> Hinting>
```

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

### Buffer::wrap

Source: https://pop-os.github.io/cosmic-text/cosmic_text/struct.Buffer.html?search=

Gets the current Wrap mode.

```APIDOC
## Buffer::wrap

### Description
Get the current `Wrap`

### Returns
`Wrap` - The current wrap mode.
```

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

### Create New SwashCache

Source: https://pop-os.github.io/cosmic-text/cosmic_text/struct.SwashCache.html?search=std%3A%3Avec

Initializes a new instance of SwashCache. Use this to start a fresh cache.

```rust
pub fn new() -> Self>
```

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

### Change Management

Source: https://pop-os.github.io/cosmic-text/cosmic_text/trait.Edit.html?search=std%3A%3Avec

Methods for applying, starting, and finishing changes to the buffer.

```APIDOC
## fn apply_change(&mut self, change: &Change) -> bool

### Description
Apply a change.

### Method
`apply_change`
```

```APIDOC
## fn start_change(&mut self)

### Description
Start collecting change.

### Method
`start_change`
```

```APIDOC
## fn finish_change(&mut self) -> Option<Change>

### Description
Get completed change.

### Method
`finish_change`
```

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

### Rust Get Selection Bounds

Source: https://pop-os.github.io/cosmic-text/cosmic_text/trait.Edit.html?search=std%3A%3Avec

Returns the start and end `Cursor` positions of the current selection, if any. Returns `Some((start, end))` or `None` if no text is selected.

```rust
fn selection_bounds(&self) -> Option<(Cursor, Cursor)> {
    ...
}
```

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

### start_change

Source: https://pop-os.github.io/cosmic-text/cosmic_text/trait.Edit.html

Begins a new change tracking session.

```APIDOC
## start_change

### Description
Start collecting change.

### Method
`start_change(&mut self)`
```

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

### Basic Text Handling with COSMIC Text

Source: https://pop-os.github.io/cosmic-text/cosmic_text/index.html?search=std%3A%3Avec

Demonstrates the core workflow of creating a FontSystem, Buffer, setting text attributes, and laying out text. Use this to initialize text rendering and layout in your application.

```rust
use cosmic_text::{Attrs, Color, FontSystem, SwashCache, Buffer, Metrics, Shaping};

// A FontSystem provides access to detected system fonts, create one per application
let mut font_system = FontSystem::new();

// A SwashCache stores rasterized glyphs, create one per application
let mut swash_cache = SwashCache::new();

// Text metrics indicate the font size and line height of a buffer
let metrics = Metrics::new(14.0, 20.0);

// A Buffer provides shaping and layout for a UTF-8 string, create one per text widget
let mut buffer = Buffer::new(&mut font_system, metrics);

// Borrow buffer together with the font system for more convenient method calls
let mut buffer = buffer.borrow_with(&mut font_system);

// Attributes indicate what font to choose
let attrs = Attrs::new();

// Set size and text
buffer.set_size(Some(80.0), Some(25.0));
buffer.set_text("Hello, Rust! 🦀\n", &attrs, Shaping::Advanced, None);

// Inspect the output runs
for run in buffer.layout_runs() {
    for glyph in run.glyphs.iter() {
        println!("{:#?}", glyph);
    }
}

// Create a default text color
let text_color = Color::rgb(0xFF, 0xFF, 0xFF);

// Draw the buffer (for performance, instead use SwashCache directly)
buffer.draw(&mut swash_cache, text_color, |x, y, w, h, color| {
    // Fill in your code here for drawing rectangles
});
```

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

### Edit::selection_bounds

Source: https://pop-os.github.io/cosmic-text/cosmic_text/struct.Editor.html?search=std%3A%3Avec

Gets the start and end cursors of the current selection.

```APIDOC
## Edit::selection_bounds

### Description
Get the bounds of the current selection

### Signature
```rust
fn selection_bounds(&self) -> Option<(Cursor, Cursor)>
```
```

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

### Get Selection Bounds

Source: https://pop-os.github.io/cosmic-text/cosmic_text/struct.Editor.html?search=

Returns the start and end `Cursor` positions of the current selection. Returns `None` if no text is currently selected.

```rust
fn selection_bounds(&self) -> Option<(Cursor, Cursor)>
```

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

### Initialize and Use COSMIC Text Buffer

Source: https://pop-os.github.io/cosmic-text/cosmic_text/index.html

Demonstrates the basic workflow of creating a FontSystem, SwashCache, and Buffer, setting text attributes, and laying out text. Use this pattern to handle text shaping and layout for display.

```rust
use cosmic_text::{Attrs, Color, FontSystem, SwashCache, Buffer, Metrics, Shaping};

// A FontSystem provides access to detected system fonts, create one per application
let mut font_system = FontSystem::new();

// A SwashCache stores rasterized glyphs, create one per application
let mut swash_cache = SwashCache::new();

// Text metrics indicate the font size and line height of a buffer
let metrics = Metrics::new(14.0, 20.0);

// A Buffer provides shaping and layout for a UTF-8 string, create one per text widget
let mut buffer = Buffer::new(&mut font_system, metrics);

// Borrow buffer together with the font system for more convenient method calls
let mut buffer = buffer.borrow_with(&mut font_system);

// Attributes indicate what font to choose
let attrs = Attrs::new();

// Set size and text
buffer.set_size(Some(80.0), Some(25.0));
buffer.set_text("Hello, Rust! 🦀\n", &attrs, Shaping::Advanced, None);

// Inspect the output runs
for run in buffer.layout_runs() {
    for glyph in run.glyphs.iter() {
        println!("{:#?}", glyph);
    }
}

// Create a default text color
let text_color = Color::rgb(0xFF, 0xFF, 0xFF);

// Draw the buffer (for performance, instead use SwashCache directly)
buffer.draw(&mut swash_cache, text_color, |x, y, w, h, color| {
    // Fill in your code here for drawing rectangles
});

```

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

### Get Laid Out Line

Source: https://pop-os.github.io/cosmic-text/cosmic_text/struct.Buffer.html

Retrieves the layout result for a specific line index.

```rust
pub fn line_layout(
    &mut self,
    font_system: &mut FontSystem,
    line_i: usize,
) -> Option<&[LayoutLine]>
```

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

### Implement CloneToUninit (Nightly)

Source: https://pop-os.github.io/cosmic-text/cosmic_text/struct.Color.html

Nightly-only experimental API for cloning Color data into uninitialized memory.

```rust
unsafe fn clone_to_uninit(&self, dest: *mut u8)

```

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

### BufferStart Motion

Source: https://pop-os.github.io/cosmic-text/cosmic_text/enum.Motion.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Moves the cursor to the very beginning of the document buffer.

```rust
BufferStart
```

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

### Editor::new

Source: https://pop-os.github.io/cosmic-text/cosmic_text/struct.Editor.html?search=std%3A%3Avec

Creates a new Editor instance with the provided BufferRef. This is the entry point for initializing an editor.

```rust
pub fn new(buffer: impl Into<BufferRef<'buffer>>) -> Self
```

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

### Any::type_id

Source: https://pop-os.github.io/cosmic-text/cosmic_text/struct.ShapeGlyph.html?search=u32+-%3E+bool

Gets the `TypeId` of `self`.

```APIDOC
## Any::type_id

### Description
Gets the `TypeId` of `self`.

### Signature
`fn type_id(&self) -> TypeId`
```

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

### Create FontSystem with Locale, Database, and Fallback

Source: https://pop-os.github.io/cosmic-text/cosmic_text/struct.FontSystem.html

Initializes a FontSystem with a specific locale, font database, and a custom font fallback list.

```rust
pub fn new_with_locale_and_db_and_fallback( locale: String, db: Database, impl_fallback: impl Fallback + 'static, ) -> Self
```

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

### Buffer::new

Source: https://pop-os.github.io/cosmic-text/cosmic_text/struct.Buffer.html

Creates a new Buffer with the provided FontSystem and Metrics. Panics if metrics.line_height is zero.

```APIDOC
## Buffer::new

### Description
Create a new `Buffer` with the provided `FontSystem` and `Metrics`

### Method
`pub fn new(font_system: &mut FontSystem, metrics: Metrics) -> Self`

### Panics
Will panic if `metrics.line_height` is zero.
```

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

### TypeId

Source: https://pop-os.github.io/cosmic-text/cosmic_text/struct.Editor.html?search=std%3A%3Avec

Gets the TypeId of self.

```APIDOC
## fn type_id(&self) -> TypeId

### Description
Gets the `TypeId` of `self`.

### Method
`type_id`

### Parameters
None

### Return Value
- `TypeId`: The type identifier of the object.
```

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

### Implement CloneToUninit (Nightly)

Source: https://pop-os.github.io/cosmic-text/cosmic_text/enum.SwashContent.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Nightly-only experimental API for copying data to uninitialized memory.

```rust
impl<T> CloneToUninit for T
where T: Clone,
Source

#### unsafe fn clone_to_uninit(&self, dest: *mut u8)
🔬This is a nightly-only experimental API. (`clone_to_uninit`)
Performs copy-assignment from `self` to `dest`. Read more
Source
```

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

### type_id

Source: https://pop-os.github.io/cosmic-text/cosmic_text/struct.BidiParagraphs.html

Gets the TypeId of self.

```APIDOC
## fn type_id(&self) -> TypeId

### Description
Gets the `TypeId` of `self`.

### Returns
- `TypeId`: The unique identifier for the type of `self`.
```

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

### Start Change Collection

Source: https://pop-os.github.io/cosmic-text/cosmic_text/struct.Editor.html?search=

Begins collecting a series of changes to be applied as a single atomic operation.

```rust
fn start_change(&mut self)
```

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

### CacheKeyFlags Initialization Methods

Source: https://pop-os.github.io/cosmic-text/cosmic_text/struct.CacheKeyFlags.html?search=u32+-%3E+bool

Methods for creating and initializing CacheKeyFlags instances.

```APIDOC
## CacheKeyFlags Initialization

### empty()
Get a flags value with all bits unset.

### all()
Get a flags value with all known bits set.

### from_bits(bits: u32) -> Option<Self>
Convert from a bits value. Returns `None` if any unknown bits are set.

### from_bits_truncate(bits: u32) -> Self
Convert from a bits value, unsetting any unknown bits.

### from_bits_retain(bits: u32) -> Self
Convert from a bits value exactly.

### from_name(name: &str) -> Option<Self>
Get a flags value with the bits of a flag with the given name set. Returns `None` if `name` is empty or doesn’t correspond to any named flag.
```

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

### selection

Source: https://pop-os.github.io/cosmic-text/cosmic_text/trait.Edit.html

Get the current selection range.

```APIDOC
## selection

### Description
Get the current selection position.

### Method
`selection(&self) -> Selection`
```

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

### Initialize FontFallbackIter

Source: https://pop-os.github.io/cosmic-text/cosmic_text/fallback/struct.FontFallbackIter.html

Creates a new FontFallbackIter instance. Requires a mutable FontSystem, font match keys, default families, scripts, the word to shape, and the ideal font weight.

```rust
pub fn new( font_system: &'a mut FontSystem, font_match_keys: &'a [FontMatchKey], default_families: &'a [&'a Family<'a>], scripts: &'a [Script], word: &'a str, ideal_weight: Weight, ) -> Self
```

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

### TypeId

Source: https://pop-os.github.io/cosmic-text/cosmic_text/struct.Editor.html

Gets the `TypeId` of the editor instance.

```APIDOC
## fn type_id(&self) -> TypeId

### Description
Gets the `TypeId` of `self`.

### Method
`type_id`

### Parameters
None

### Response
- **TypeId**: The unique identifier for the type of the editor instance.
```

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

### Edit::start_change

Source: https://pop-os.github.io/cosmic-text/cosmic_text/struct.Editor.html?search=std%3A%3Avec

Begins collecting changes.

```APIDOC
## Edit::start_change

### Description
Start collecting change

### Signature
```rust
fn start_change(&mut self)
```
```

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

### Buffer::tab_width

Source: https://pop-os.github.io/cosmic-text/cosmic_text/struct.Buffer.html

Gets the current tab_width.

```APIDOC
## Buffer::tab_width

### Description
Get the current `tab_width`

### Method
`pub const fn tab_width(&self) -> u16`
```

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

### FontSystem::new

Source: https://pop-os.github.io/cosmic-text/cosmic_text/struct.FontSystem.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Creates a new FontSystem instance, providing access to installed system fonts. This operation can be time-consuming and should ideally be performed once with the result shared.

```APIDOC
## FontSystem::new

### Description
Creates a new `FontSystem`, that allows access to any installed system fonts.

### §Timing
This function takes some time to run. On the release build, it can take up to a second, while debug builds can take up to ten times longer. For this reason, it should only be called once, and the resulting `FontSystem` should be shared.

### Signature
```rust
pub fn new() -> Self
```
```

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

### tab_width

Source: https://pop-os.github.io/cosmic-text/cosmic_text/trait.Edit.html

Get the current tab width setting.

```APIDOC
## tab_width

### Description
Get the current tab width.

### Method
`tab_width(&self) -> u16`
```

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

### Get Wrap Mode

Source: https://pop-os.github.io/cosmic-text/cosmic_text/struct.Buffer.html

Returns the current text wrapping mode.

```rust
pub const fn wrap(&self) -> Wrap>
```

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

### ParagraphStart Motion

Source: https://pop-os.github.io/cosmic-text/cosmic_text/enum.Motion.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Moves the cursor to the beginning of the current paragraph.

```rust
ParagraphStart
```

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

### type_id

Source: https://pop-os.github.io/cosmic-text/cosmic_text/struct.LineIter.html?search=std%3A%3Avec

Gets the `TypeId` of `self`. This is an implementation of the `Any` trait.

```APIDOC
## fn type_id(&self) -> TypeId

### Description
Gets the `TypeId` of `self`.

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **TypeId**: The unique identifier for the type of `self`.

#### Response Example
None
```

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

### Edit::redraw

Source: https://pop-os.github.io/cosmic-text/cosmic_text/struct.Editor.html?search=std%3A%3Avec

Gets the redraw flag of the Buffer.

```APIDOC
## Edit::redraw

### Description
Get the `Buffer` redraw flag

### Signature
```rust
fn redraw(&self) -> bool
```
```

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

### impl Placement

Source: https://pop-os.github.io/cosmic-text/cosmic_text/struct.Placement.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Provides methods for the Placement struct.

```APIDOC
### impl Placement

#### pub fn compute( origin: Origin, offset: impl Into<Vector>, bounds: &Bounds, ) -> (Vector, Placement)

Given an origin, offset and bounding box, computes the resulting offset and placement for a tightly bounded mask.
```

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

### Start Change Collection

Source: https://pop-os.github.io/cosmic-text/cosmic_text/trait.Edit.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Begins collecting a sequence of edits that can be grouped into a single undo/redo operation.

```rust
fn start_change(&mut self);
```

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

### LayoutRunIter::new

Source: https://pop-os.github.io/cosmic-text/cosmic_text/struct.LayoutRunIter.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Creates a new LayoutRunIter from a Buffer.

```APIDOC
## LayoutRunIter::new

### Description
Creates a new `LayoutRunIter` from a `Buffer`.

### Signature
```rust
pub const fn new(buffer: &'b Buffer) -> Self
```
```

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

### Edit::selection

Source: https://pop-os.github.io/cosmic-text/cosmic_text/struct.Editor.html?search=std%3A%3Avec

Gets the current selection range.

```APIDOC
## Edit::selection

### Description
Get the current selection position

### Signature
```rust
fn selection(&self) -> Selection
```
```

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

### Get Layout for Line

Source: https://pop-os.github.io/cosmic-text/cosmic_text/struct.BorrowedWithFontSystem.html?search=

Retrieves the layout information for a specific line by its index.

```rust
pub fn line_layout(&mut self, line_i: usize) -> Option<&[LayoutLine]>
```

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

### Edit::cursor

Source: https://pop-os.github.io/cosmic-text/cosmic_text/struct.Editor.html?search=std%3A%3Avec

Gets the current cursor position.

```APIDOC
## Edit::cursor

### Description
Get the current cursor

### Signature
```rust
fn cursor(&self) -> Cursor
```
```

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

### TryInto

Source: https://pop-os.github.io/cosmic-text/cosmic_text/struct.Editor.html?search=std%3A%3Avec

Performs the conversion.

```APIDOC
## fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

### Description
Performs the conversion.

### Method
`try_into`

### Parameters
None

### Return Value
- `Result<U, <U as TryFrom<T>>::Error>`: A Result containing the converted value or an error.
```

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

### Edit::buffer_ref

Source: https://pop-os.github.io/cosmic-text/cosmic_text/struct.Editor.html?search=std%3A%3Avec

Gets a reference to the internal `BufferRef`.

```APIDOC
## Edit::buffer_ref

### Description
Get the internal `BufferRef`

### Signature
```rust
fn buffer_ref(&self) -> &BufferRef<'buffer>
```
```

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

### Create LayoutRunIter from Lines

Source: https://pop-os.github.io/cosmic-text/cosmic_text/struct.LayoutRunIter.html?search=

Constructor for LayoutRunIter that takes a slice of BufferLines and layout parameters.

```rust
pub const fn from_lines( lines: &'b [BufferLine], height_opt: Option<f32>, line_height: f32, scroll: f32, start: usize, ) -> Self
```

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

### LayoutRunIter::new

Source: https://pop-os.github.io/cosmic-text/cosmic_text/struct.LayoutRunIter.html?search=

Constructs a new LayoutRunIter from a Buffer.

```APIDOC
## LayoutRunIter::new

### Description
Constructs a new `LayoutRunIter` from a `Buffer`.

### Method
`const fn new(buffer: &'b Buffer) -> Self`

### Parameters
* **buffer** (`&'b Buffer`) - The buffer to create the iterator from.
```

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

### Color::a

Source: https://pop-os.github.io/cosmic-text/cosmic_text/struct.Color.html

Gets the alpha component of the color.

```APIDOC
## pub const fn a(&self) -> u8

### Description
Get the alpha component

### Returns
- u8 - The alpha component of the color.
```

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

### FontSystem::new_with_locale_and_db_and_fallback

Source: https://pop-os.github.io/cosmic-text/cosmic_text/struct.FontSystem.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Creates a new FontSystem instance configured with a specific locale, font database, and fallback font list.

```APIDOC
## FontSystem::new_with_locale_and_db_and_fallback

### Description
Create a new `FontSystem` with a pre-specified locale, font database and font fallback list.

### Signature
```rust
pub fn new_with_locale_and_db_and_fallback( locale: String, db: Database, impl_fallback: impl Fallback + 'static, ) -> Self
```
```

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

### Color::b

Source: https://pop-os.github.io/cosmic-text/cosmic_text/struct.Color.html

Gets the blue component of the color.

```APIDOC
## pub const fn b(&self) -> u8

### Description
Get the blue component

### Returns
- u8 - The blue component of the color.
```

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

### Color::g

Source: https://pop-os.github.io/cosmic-text/cosmic_text/struct.Color.html

Gets the green component of the color.

```APIDOC
## pub const fn g(&self) -> u8

### Description
Get the green component

### Returns
- u8 - The green component of the color.
```

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

### Clone Implementation

Source: https://pop-os.github.io/cosmic-text/cosmic_text/struct.FontMatchKey.html

Details on how to clone a FontMatchKey instance.

```APIDOC
## Trait Implementations

### impl Clone for FontMatchKey

#### fn clone(&self) -> FontMatchKey

Returns a duplicate of the value.

#### fn clone_from(&mut self, source: &Self)

Performs copy-assignment from `source`.
```

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

### Color::r

Source: https://pop-os.github.io/cosmic-text/cosmic_text/struct.Color.html

Gets the red component of the color.

```APIDOC
## pub const fn r(&self) -> u8

### Description
Get the red component

### Returns
- u8 - The red component of the color.
```

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

### try_from

Source: https://pop-os.github.io/cosmic-text/cosmic_text/struct.BidiParagraphs.html

Performs the conversion.

```APIDOC
## type Error = Infallible
## fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
where U: Into<T>,

### Description
Performs the conversion.

### Parameters
- `value`: The value to be converted.

### Returns
- `Result<T, <T as TryFrom<U>>::Error>`: The result of the conversion, which is either the converted value or an error.
```

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

### CloneToUninit

Source: https://pop-os.github.io/cosmic-text/cosmic_text/struct.Editor.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Experimental API for cloning data to an uninitialized memory location.

```APIDOC
## unsafe fn clone_to_uninit(&self, dest: *mut u8)

### Description
🔬This is a nightly-only experimental API. (`clone_to_uninit`)
Performs copy-assignment from `self` to `dest`.

### Method
`clone_to_uninit`

### Parameters
- `dest` (*mut u8): A mutable pointer to the destination memory location.

### Safety
This function is unsafe and requires the caller to ensure that `dest` is a valid, mutable pointer to a region of memory large enough to hold the cloned value.
```

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

### Color::a

Source: https://pop-os.github.io/cosmic-text/cosmic_text/struct.Color.html?search=

Gets the alpha component of the color.

```APIDOC
## Color::a

### Description
Get the alpha component.

### Method Signature
```rust
pub const fn a(&self) -> u8
```

### Returns
The alpha component of the color.
```

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

### Color::b

Source: https://pop-os.github.io/cosmic-text/cosmic_text/struct.Color.html?search=

Gets the blue component of the color.

```APIDOC
## Color::b

### Description
Get the blue component.

### Method Signature
```rust
pub const fn b(&self) -> u8
```

### Returns
The blue component of the color.
```

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

### CacheKeyFlags Initialization Methods

Source: https://pop-os.github.io/cosmic-text/cosmic_text/struct.CacheKeyFlags.html

Methods for creating CacheKeyFlags instances. `empty` creates a flags value with no bits set, while `all` sets all known bits.

```rust
pub const fn empty() -> Self
```

```rust
pub const fn all() -> Self
```

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

### Implement CloneToUninit for T (Nightly)

Source: https://pop-os.github.io/cosmic-text/cosmic_text/struct.DecorationMetrics.html?search=

Nightly-only experimental API for copying data to uninitialized memory.

```rust
impl<T> CloneToUninit for T
where T: Clone,
Source§
#### unsafe fn clone_to_uninit(&self, dest: *mut u8)
🔬This is a nightly-only experimental API. (`clone_to_uninit`)
Performs copy-assignment from `self` to `dest`. Read more
```

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

### Color::g

Source: https://pop-os.github.io/cosmic-text/cosmic_text/struct.Color.html?search=

Gets the green component of the color.

```APIDOC
## Color::g

### Description
Get the green component.

### Method Signature
```rust
pub const fn g(&self) -> u8
```

### Returns
The green component of the color.
```

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

### Color::r

Source: https://pop-os.github.io/cosmic-text/cosmic_text/struct.Color.html?search=

Gets the red component of the color.

```APIDOC
## Color::r

### Description
Get the red component.

### Method Signature
```rust
pub const fn r(&self) -> u8
```

### Returns
The red component of the color.
```

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

### Color::a

Source: https://pop-os.github.io/cosmic-text/cosmic_text/struct.Color.html?search=std%3A%3Avec

Gets the alpha component of the color.

```APIDOC
## Color::a

### Description
Get the alpha component.

### Signature
```rust
pub const fn a(&self) -> u8
```
```

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

### SubpixelBin::new

Source: https://pop-os.github.io/cosmic-text/cosmic_text/enum.SubpixelBin.html?search=u32+-%3E+bool

Creates a new SubpixelBin from a given f32 position.

```APIDOC
## pub fn new(pos: f32) -> (i32, Self)

Creates a new `SubpixelBin` from a given `f32` position. This function likely determines the appropriate binning based on the input position value.
```

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

### into

Source: https://pop-os.github.io/cosmic-text/cosmic_text/struct.BidiParagraphs.html

Calls U::from(self).

```APIDOC
## fn into(self) -> U
where U: From<T>,

### Description
Calls `U::from(self)`. This conversion is whatever the implementation of `From<T> for U` chooses to do.

### Returns
- `U`: The converted value.
```

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

### Color::b

Source: https://pop-os.github.io/cosmic-text/cosmic_text/struct.Color.html?search=std%3A%3Avec

Gets the blue component of the color.

```APIDOC
## Color::b

### Description
Get the blue component.

### Signature
```rust
pub const fn b(&self) -> u8
```
```

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

### Color::g

Source: https://pop-os.github.io/cosmic-text/cosmic_text/struct.Color.html?search=std%3A%3Avec

Gets the green component of the color.

```APIDOC
## Color::g

### Description
Get the green component.

### Signature
```rust
pub const fn g(&self) -> u8
```
```

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

### Into

Source: https://pop-os.github.io/cosmic-text/cosmic_text/struct.Editor.html?search=std%3A%3Avec

Calls U::from(self).

```APIDOC
## fn into(self) -> U

### Description
Calls `U::from(self)`. That is, this conversion is whatever the implementation of `From<T> for U` chooses to do.

### Method
`into`

### Parameters
None

### Return Value
- `U`: The converted value.
```

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

### Create FontSystem with Locale and Database

Source: https://pop-os.github.io/cosmic-text/cosmic_text/struct.FontSystem.html

Constructs a new FontSystem using a provided locale and font database.

```rust
pub fn new_with_locale_and_db(locale: String, db: Database) -> Self
```

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

### Color::r

Source: https://pop-os.github.io/cosmic-text/cosmic_text/struct.Color.html?search=std%3A%3Avec

Gets the red component of the color.

```APIDOC
## Color::r

### Description
Get the red component.

### Signature
```rust
pub const fn r(&self) -> u8
```
```

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

### Buffer::ellipsize

Source: https://pop-os.github.io/cosmic-text/cosmic_text/struct.Buffer.html?search=

Gets the current Ellipsize mode.

```APIDOC
## Buffer::ellipsize

### Description
Get the current `Ellipsize`

### Returns
`Ellipsize` - The current ellipsizing mode.
```

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

### TryFrom

Source: https://pop-os.github.io/cosmic-text/cosmic_text/struct.Editor.html?search=std%3A%3Avec

Performs the conversion.

```APIDOC
## fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

### Description
Performs the conversion.

### Method
`try_from`

### Parameters
- `value` (U): The value to be converted.

### Return Value
- `Result<T, <T as TryFrom<U>>::Error>`: A Result containing the converted value or an error.
```

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

### Buffer::scroll

Source: https://pop-os.github.io/cosmic-text/cosmic_text/struct.Buffer.html

Gets the current scroll location.

```APIDOC
## Buffer::scroll

### Description
Get the current scroll location

### Method
`pub const fn scroll(&self) -> Scroll`
```

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

### CloneToUninit

Source: https://pop-os.github.io/cosmic-text/cosmic_text/struct.Editor.html?search=std%3A%3Avec

Performs copy-assignment from self to dest. This is a nightly-only experimental API.

```APIDOC
## unsafe fn clone_to_uninit(&self, dest: *mut u8)

### Description
Performs copy-assignment from `self` to `dest`. This is a nightly-only experimental API.

### Method
`clone_to_uninit`

### Parameters
- `dest` (*mut u8): A mutable pointer to the destination memory location.

### Safety
This function is unsafe and requires `T: Clone`.
```

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

### CacheKeyFlags Initialization Methods

Source: https://pop-os.github.io/cosmic-text/cosmic_text/struct.CacheKeyFlags.html?search=

Methods for creating CacheKeyFlags instances. Use `empty` for no flags, `all` for all known flags, or `from_bits` to construct from raw integer values.

```rust
pub const fn empty() -> Self
```

```rust
pub const fn all() -> Self
```

```rust
pub const fn from_bits(bits: u32) -> Option<Self>
```

```rust
pub const fn from_bits_truncate(bits: u32) -> Self
```

```rust
pub const fn from_bits_retain(bits: u32) -> Self
```

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

### Buffer::monospace_width

Source: https://pop-os.github.io/cosmic-text/cosmic_text/struct.Buffer.html

Gets the current monospace_width setting.

```APIDOC
## Buffer::monospace_width

### Description
Get the current `monospace_width`

### Method
`pub const fn monospace_width(&self) -> Option<f32>`
```

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

### Buffer::ellipsize

Source: https://pop-os.github.io/cosmic-text/cosmic_text/struct.Buffer.html

Gets the current Ellipsize setting.

```APIDOC
## Buffer::ellipsize

### Description
Get the current `Ellipsize`

### Method
`pub const fn ellipsize(&self) -> Ellipsize`
```

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

### Font Constructor

Source: https://pop-os.github.io/cosmic-text/cosmic_text/struct.Font.html?search=std%3A%3Avec

Creates a new Font instance. It requires a Database reference, a font ID, and a weight, returning an Option<Self> as the font might not be found or loadable.

```APIDOC
### impl Font

#### pub fn new(db: &Database, id: ID, weight: Weight) -> Option<Self>
Creates a new Font instance from a database, ID, and weight. Returns `None` if the font cannot be created.
```

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

### Create Buffer with FontSystem

Source: https://pop-os.github.io/cosmic-text/cosmic_text/struct.Buffer.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Creates a new Buffer with a FontSystem and specified metrics. Panics if metrics.line_height is zero.

```rust
pub fn new(font_system: &mut FontSystem, metrics: Metrics) -> Self
```

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

### Font::new

Source: https://pop-os.github.io/cosmic-text/cosmic_text/struct.Font.html

Creates a new Font instance from a Database, ID, and Weight. Returns an Option<Self> which is None if the font could not be created.

```APIDOC
## Font::new

### Description
Creates a new Font instance from a Database, ID, and Weight. Returns an Option<Self> which is None if the font could not be created.

### Signature
`pub fn new(db: &Database, id: ID, weight: Weight) -> Option<Self>`

### Parameters
- `db` (&Database): A reference to the Database.
- `id` (ID): The identifier for the font.
- `weight` (Weight): The weight of the font.

### Returns
- `Option<Self>`: An Option containing the Font instance if successful, otherwise None.
```

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

### Buffer::metrics

Source: https://pop-os.github.io/cosmic-text/cosmic_text/struct.Buffer.html

Gets the current Metrics of the buffer.

```APIDOC
## Buffer::metrics

### Description
Get the current `Metrics`

### Method
`pub const fn metrics(&self) -> Metrics`
```

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

### Blanket Implementations

Source: https://pop-os.github.io/cosmic-text/cosmic_text/struct.Metrics.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Demonstrates blanket implementations for generic types, showing how traits like Any, Borrow, CloneToUninit, From, Into, ToOwned, ToSmolStr, ToString, TryFrom, and TryInto can be applied.

```APIDOC
## Blanket Implementations

### `impl<T> Any for T`
- `fn type_id(&self) -> TypeId`: Gets the `TypeId` of `self`.

### `impl<T> Borrow<T> for T`
- `fn borrow(&self) -> &T`: Immutably borrows from an owned value.

### `impl<T> BorrowMut<T> for T`
- `fn borrow_mut(&mut self) -> &mut T`: Mutably borrows from an owned value.

### `impl<T> CloneToUninit for T`
- `unsafe fn clone_to_uninit(&self, dest: *mut u8)`: Performs copy-assignment from `self` to `dest`.

### `impl<T> From<T> for T`
- `fn from(t: T) -> T`: Returns the argument unchanged.

### `impl<T, U> Into<U> for T`
- `fn into(self) -> U`: Calls `U::from(self)`.

### `impl<T> ToOwned for T`
- `type Owned = T`
- `fn to_owned(&self) -> T`: Creates owned data from borrowed data, usually by cloning.
- `fn clone_into(&self, target: &mut T)`: Uses borrowed data to replace owned data, usually by cloning.

### `impl<T> ToSmolStr for T`
- `fn to_smolstr(&self) -> SmolStr`

### `impl<T> ToString for T`
- `fn to_string(&self) -> String`: Converts the given value to a `String`.

### `impl<T, U> TryFrom<U> for T`
- `type Error = Infallible`
- `fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>`: Performs the conversion.

### `impl<T, U> TryInto<U> for T`
- `type Error = <U as TryFrom<T>>::Error>`
```

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

### BufferLine::align

Source: https://pop-os.github.io/cosmic-text/cosmic_text/struct.BufferLine.html

Gets the text alignment for the BufferLine.

```APIDOC
## BufferLine::align

### Description
Get the Text alignment.

### Signature
```rust
pub const fn align(&self) -> Option<Align>
```
```

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

### SwashCache::new

Source: https://pop-os.github.io/cosmic-text/cosmic_text/struct.SwashCache.html

Creates a new, empty SwashCache.

```APIDOC
## new

### Description
Create a new swash cache.

### Method
`new()`

### Returns
- `Self`: A new instance of SwashCache.
```

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

### SwashCache::new

Source: https://pop-os.github.io/cosmic-text/cosmic_text/struct.SwashCache.html?search=

Creates a new, empty SwashCache.

```APIDOC
## SwashCache::new

### Description
Create a new swash cache.

### Method
`new()`

### Returns
- `Self`: A new instance of SwashCache.
```

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

### selection_bounds

Source: https://pop-os.github.io/cosmic-text/cosmic_text/trait.Edit.html

Retrieves the start and end cursors of the current selection.

```APIDOC
## selection_bounds

### Description
Get the bounds of the current selection.

### Method
`selection_bounds(&self) -> Option<(Cursor, Cursor)>`
```

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

### buffer_ref_mut

Source: https://pop-os.github.io/cosmic-text/cosmic_text/trait.Edit.html

Get a mutable reference to the internal BufferRef for modifications.

```APIDOC
## buffer_ref_mut

### Description
Get the internal `BufferRef`.

### Method
`buffer_ref_mut(&mut self) -> &mut BufferRef<'buffer>`
```

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

### buffer_ref

Source: https://pop-os.github.io/cosmic-text/cosmic_text/trait.Edit.html

Get a reference to the internal BufferRef for read-only access.

```APIDOC
## buffer_ref

### Description
Get the internal `BufferRef`.

### Method
`buffer_ref(&self) -> &BufferRef<'buffer>`
```

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

### Edit::tab_width

Source: https://pop-os.github.io/cosmic-text/cosmic_text/struct.Editor.html?search=std%3A%3Avec

Gets the current tab width setting.

```APIDOC
## Edit::tab_width

### Description
Get the current tab width

### Signature
```rust
fn tab_width(&self) -> u16
```
```

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

### Edit::buffer_ref_mut

Source: https://pop-os.github.io/cosmic-text/cosmic_text/struct.Editor.html?search=std%3A%3Avec

Gets a mutable reference to the internal `BufferRef`.

```APIDOC
## Edit::buffer_ref_mut

### Description
Get the internal `BufferRef`

### Signature
```rust
fn buffer_ref_mut(&mut self) -> &mut BufferRef<'buffer>
```
```

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

### Placement::fmt Method

Source: https://pop-os.github.io/cosmic-text/cosmic_text/struct.Placement.html?search=u32+-%3E+bool

Formats the Placement value using the given formatter.

```APIDOC
### impl Debug for Placement

#### fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.
```

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

### Get Font ID

Source: https://pop-os.github.io/cosmic-text/cosmic_text/struct.Font.html

Returns the unique identifier for the font.

```rust
pub const fn id(&self) -> ID
```

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

### LayoutRunIter::new

Source: https://pop-os.github.io/cosmic-text/cosmic_text/struct.LayoutRunIter.html

Constructs a new LayoutRunIter from a Buffer. This iterator yields visible text lines.

```APIDOC
## LayoutRunIter::new

### Description
Constructs a new `LayoutRunIter` from a `Buffer`. This iterator yields visible text lines.

### Method
`pub const fn new(buffer: &'b Buffer) -> Self`
```

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

### Get Blue Component

Source: https://pop-os.github.io/cosmic-text/cosmic_text/struct.Color.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Retrieves the blue component of the color.

```rust
pub const fn b(&self) -> u8
```

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

### Get Green Component

Source: https://pop-os.github.io/cosmic-text/cosmic_text/struct.Color.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Retrieves the green component of the color.

```rust
pub const fn g(&self) -> u8
```

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

### Color Constructors

Source: https://pop-os.github.io/cosmic-text/cosmic_text/struct.Color.html?search=u32+-%3E+bool

Provides methods to create new Color instances.

```APIDOC
## impl Color

### `pub const fn rgb(r: u8, g: u8, b: u8) -> Self`

Create new color with red, green, and blue components.

### `pub const fn rgba(r: u8, g: u8, b: u8, a: u8) -> Self`

Create new color with red, green, blue, and alpha components.
```

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

### Get Red Component

Source: https://pop-os.github.io/cosmic-text/cosmic_text/struct.Color.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Retrieves the red component of the color.

```rust
pub const fn r(&self) -> u8
```

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

### LayoutCursor::new

Source: https://pop-os.github.io/cosmic-text/cosmic_text/struct.LayoutCursor.html?search=

Creates a new LayoutCursor with the specified line, layout, and glyph indices.

```APIDOC
## LayoutCursor::new

### Description
Create a new `LayoutCursor`.

### Signature
`pub const fn new(line: usize, layout: usize, glyph: usize) -> Self`
```

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

### LayoutCursor::new

Source: https://pop-os.github.io/cosmic-text/cosmic_text/struct.LayoutCursor.html?search=std%3A%3Avec

Creates a new LayoutCursor with the specified line, layout, and glyph indices.

```APIDOC
## LayoutCursor::new

### Description
Creates a new `LayoutCursor` with the specified line, layout, and glyph indices.

### Signature
```rust
pub const fn new(line: usize, layout: usize, glyph: usize) -> Self
```

### Parameters
* `line`: `usize` - The index of the `BufferLine`.
* `layout`: `usize` - The index of the `LayoutLine`.
* `glyph`: `usize` - The index of the `LayoutGlyph`.
```

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

### layout_runs

Source: https://pop-os.github.io/cosmic-text/cosmic_text/struct.Buffer.html?search=std%3A%3Avec

Gets the visible layout runs for rendering and other tasks.

```APIDOC
## layout_runs

### Description
Gets the visible layout runs for rendering and other tasks. This returns an iterator over the laid-out runs that are visible in the current scroll region. Call `shape_until_scroll` first to ensure the buffer is up to date, or use `BorrowedWithFontSystem` which calls it automatically.

### Method
`pub fn layout_runs(&self) -> LayoutRunIter<'_>`

### Returns
- `LayoutRunIter<'_>`: An iterator over the visible layout runs.
```

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

### LayoutCursor::new

Source: https://pop-os.github.io/cosmic-text/cosmic_text/struct.LayoutCursor.html

Creates a new LayoutCursor with the specified line, layout, and glyph indices.

```APIDOC
## LayoutCursor::new

### Description
Creates a new `LayoutCursor` with the specified line, layout, and glyph indices.

### Signature
```rust
pub const fn new(line: usize, layout: usize, glyph: usize) -> Self
```

### Parameters
* `line` (usize): The index of the `BufferLine`.
* `layout` (usize): The index of the `LayoutLine` within the `BufferLine`.
* `glyph` (usize): The index of the `LayoutGlyph` within the `LayoutLine`.
```

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

### Get Metrics

Source: https://pop-os.github.io/cosmic-text/cosmic_text/struct.Buffer.html

Returns the current Metrics configuration of the buffer.

```rust
pub const fn metrics(&self) -> Metrics>
```

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

### Motion Action Example

Source: https://pop-os.github.io/cosmic-text/cosmic_text/enum.Action.html

Represents cursor movement within the editor using a Motion type. This allows for complex cursor navigation.

```rust
Motion(Motion)
```

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

### BufferLine::attrs_list

Source: https://pop-os.github.io/cosmic-text/cosmic_text/struct.BufferLine.html

Gets the attributes list associated with the BufferLine.

```APIDOC
## BufferLine::attrs_list

### Description
Get attributes list.

### Signature
```rust
pub const fn attrs_list(&self) -> &AttrsList
```
```

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

### SubpixelBin::new

Source: https://pop-os.github.io/cosmic-text/cosmic_text/enum.SubpixelBin.html?search=std%3A%3Avec

Constructs a `SubpixelBin` and its integer representation from a floating-point position.

```APIDOC
## `SubpixelBin::new(pos: f32) -> (i32, Self)`

Creates a new `SubpixelBin` and its corresponding integer representation from a given floating-point position. This is useful for optimizing cache lookups by mapping continuous float values to discrete enum variants.
```

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

### BufferLine::ending

Source: https://pop-os.github.io/cosmic-text/cosmic_text/struct.BufferLine.html

Gets the line ending type of the BufferLine.

```APIDOC
## BufferLine::ending

### Description
Get line ending.

### Signature
```rust
pub const fn ending(&self) -> LineEnding
```
```

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

### TryInto::try_into

Source: https://pop-os.github.io/cosmic-text/cosmic_text/struct.ShapeGlyph.html?search=u32+-%3E+bool

Performs the conversion.

```APIDOC
## TryInto::try_into

### Description
Performs the conversion.

### Signature
`fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>`
```

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

### Redraw Flag

Source: https://pop-os.github.io/cosmic-text/cosmic_text/trait.Edit.html?search=std%3A%3Avec

Methods to get and set the redraw flag for the buffer.

```APIDOC
## fn redraw(&self) -> bool

### Description
Get the `Buffer` redraw flag.

### Method
`redraw`
```

```APIDOC
## fn set_redraw(&mut self, redraw: bool)

### Description
Set the `Buffer` redraw flag.

### Method
`set_redraw`
```

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

### LayoutRunIter Constructors

Source: https://pop-os.github.io/cosmic-text/cosmic_text/struct.LayoutRunIter.html?search=u32+-%3E+bool

Constructors for creating a LayoutRunIter instance.

```APIDOC
## `LayoutRunIter::new`

### Description
Creates a new `LayoutRunIter` from a `Buffer`.

### Signature
`pub const fn new(buffer: &'b Buffer) -> Self`
```

```APIDOC
## `LayoutRunIter::from_lines`

### Description
Creates a new `LayoutRunIter` from a slice of `BufferLine`s with specified layout parameters.

### Signature
`pub const fn from_lines(lines: &'b [BufferLine], height_opt: Option<f32>, line_height: f32, scroll: f32, start: usize) -> Self`
```

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

### Cursor Position

Source: https://pop-os.github.io/cosmic-text/cosmic_text/trait.Edit.html?search=

Method to get the cursor's screen position.

```APIDOC
## fn cursor_position(&self) -> Option<(i32, i32)>

### Description
Get the X and Y position of the top left corner of the cursor.

### Method
GET

### Endpoint
N/A (Method call)
```

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

### Generic CloneToUninit Implementation (Nightly)

Source: https://pop-os.github.io/cosmic-text/cosmic_text/struct.Weight.html?search=std%3A%3Avec

An experimental, nightly-only API for performing copy-assignment from a value to an uninitialized memory location.

```rust
unsafe fn clone_to_uninit(&self, dest: *mut u8);

```

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

### Get Auto-indent Setting

Source: https://pop-os.github.io/cosmic-text/cosmic_text/trait.Edit.html

Check if automatic indentation is currently enabled.

```rust
fn auto_indent(&self) -> bool;

```

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

### Get Auto-Indent Setting

Source: https://pop-os.github.io/cosmic-text/cosmic_text/struct.Editor.html?search=

Retrieves the current setting for automatic indentation.

```rust
fn auto_indent(&self) -> bool
```

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

### Get Alpha Component

Source: https://pop-os.github.io/cosmic-text/cosmic_text/struct.Color.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Retrieves the alpha (transparency) component of the color.

```rust
pub const fn a(&self) -> u8
```

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

### BufferLine::layout_runs

Source: https://pop-os.github.io/cosmic-text/cosmic_text/struct.BufferLine.html?search=u32+-%3E+bool

Gets the visible layout runs for rendering and other tasks.

```APIDOC
## BufferLine::layout_runs

### Description
Get the visible layout runs for rendering and other tasks.

### Signature
`pub fn layout_runs( &self, height_opt: Option<f32>, line_height: f32, ) -> LayoutRunIter<'_>`
```

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

### Create Metrics with Given Values

Source: https://pop-os.github.io/cosmic-text/cosmic_text/struct.Metrics.html

Creates a new Metrics instance with specified font size and line height.

```rust
pub const fn new(font_size: f32, line_height: f32) -> Self
```

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

### Get Ellipsize Mode

Source: https://pop-os.github.io/cosmic-text/cosmic_text/struct.Buffer.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Retrieves the current text ellipsizing mode.

```rust
pub const fn ellipsize(&self) -> Ellipsize
```

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

### Set Metrics and Size

Source: https://pop-os.github.io/cosmic-text/cosmic_text/struct.Buffer.html?search=std%3A%3Avec

Sets both the Buffer's Metrics and dimensions simultaneously. Panics if metrics.font_size is zero.

```rust
pub fn set_metrics_and_size(
    &mut self,
    metrics: Metrics,
    width_opt: Option<f32>,
    height_opt: Option<f32>,
)>
```

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

### TryFrom::try_from

Source: https://pop-os.github.io/cosmic-text/cosmic_text/struct.ShapeGlyph.html?search=u32+-%3E+bool

Performs the conversion.

```APIDOC
## TryFrom::try_from

### Description
Performs the conversion.

### Signature
`fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>`
```

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

### SubpixelBin::new

Source: https://pop-os.github.io/cosmic-text/cosmic_text/enum.SubpixelBin.html

Creates a new SubpixelBin from a given subpixel position.

```APIDOC
## pub fn new(pos: f32) -> (i32, Self)

### Description
Creates a new SubpixelBin from a given subpixel position.

### Parameters
#### Path Parameters
- **pos** (f32) - Required - The subpixel position.
```

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

### Buffer::size

Source: https://pop-os.github.io/cosmic-text/cosmic_text/struct.Buffer.html

Gets the current buffer dimensions (width, height).

```APIDOC
## Buffer::size

### Description
Get the current buffer dimensions (width, height)

### Method
`pub const fn size(&self) -> (Option<f32>, Option<f32>)`
```

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

### Implement CloneToUninit for T (Nightly)

Source: https://pop-os.github.io/cosmic-text/cosmic_text/enum.BufferRef.html

An experimental nightly-only API for performing copy-assignment from `self` to an uninitialized memory location `dest`. Use with caution.

```rust
unsafe fn clone_to_uninit(&self, dest: *mut u8)
```

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

### Get Scroll Location

Source: https://pop-os.github.io/cosmic-text/cosmic_text/struct.Buffer.html

Retrieves the current scroll location of the buffer.

```rust
pub const fn scroll(&self) -> Scroll>
```

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

### Get Ellipsis Mode

Source: https://pop-os.github.io/cosmic-text/cosmic_text/struct.Buffer.html

Retrieves the current text ellipsis mode.

```rust
pub const fn ellipsize(&self) -> Ellipsize>
```

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

### Command Implementations

Source: https://pop-os.github.io/cosmic-text/cosmic_text/enum.Command.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Provides methods for interacting with Command variants, such as retrieving the associated verb or applying transformations.

```APIDOC
## Implementations for Command

### `impl Command`

*   **`pub fn verb(&self) -> Verb`**: Returns the associated verb for the command.
*   **`pub fn transform(&self, transform: &Transform) -> Command`**: Returns the result of a transformation matrix applied to the command.
```

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

### CacheKeyFlags Initialization and Iteration

Source: https://pop-os.github.io/cosmic-text/cosmic_text/struct.CacheKeyFlags.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Methods for initializing CacheKeyFlags from iterators and iterating over flags.

```APIDOC
## `Flags` for `CacheKeyFlags`

### `const FLAGS: &'static [Flag<CacheKeyFlags>]`

The set of defined flags.

### `type Bits = u32`

The underlying bits type.

### `fn empty() -> Self`

Get a flags value with all bits unset.

### `fn all() -> Self`

Get a flags value with all known bits set.

## `FromIterator` for `CacheKeyFlags`

### `fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self`

The bitwise or (`|`) of the bits in each flags value.

## `IntoIterator` for `CacheKeyFlags`

### `type Item = CacheKeyFlags`

The type of the elements being iterated over.
```
Tokens:
Raw