Rustybuzz

https://docs.rs/rustybuzz/latest/rustybuzz/
Admin
Rustybuzz is a complete Harfbuzz shaping algorithm ported to Rust, providing advanced text shaping...
Tokens:21,877
Snippets:357
Trust Score:9.1
Update:3 months ago
Show doc for...
Tokens:
Raw
### Search example for Option mapping

Source: https://docs.rs/rustybuzz/latest/rustybuzz/script/constant.TAKRI.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Example search query demonstrating functional mapping syntax.

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

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

### ShapePlan::new

Source: https://docs.rs/rustybuzz/latest/rustybuzz/struct.ShapePlan.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Creates a new ShapePlan instance that can be used for shaping any buffer with the provided properties.

```APIDOC
## pub fn new(face: &hb_font_t<'_>, direction: Direction, script: Option<Script>, language: Option<&Language>, user_features: &[Feature]) -> Self

### Description
Returns a plan that can be used for shaping any buffer with the provided properties.

### Parameters
- **face** (&hb_font_t<'_>) - The font face to use for shaping.
- **direction** (Direction) - The text direction.
- **script** (Option<Script>) - The script of the text.
- **language** (Option<&Language>) - The language of the text.
- **user_features** (&[Feature]) - A slice of user-defined features to apply during shaping.
```

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

### ShapePlan::new

Source: https://docs.rs/rustybuzz/latest/rustybuzz/struct.ShapePlan.html

Creates a new ShapePlan instance that can be used for shaping any buffer with the provided properties.

```APIDOC
## pub fn new(face: &hb_font_t<'_>, direction: Direction, script: Option<Script>, language: Option<&Language>, user_features: &[Feature]) -> Self

### Description
Returns a plan that can be used for shaping any buffer with the provided properties.

### Parameters
- **face** (&hb_font_t<'_>) - The font face to use for shaping.
- **direction** (Direction) - The text direction.
- **script** (Option<Script>) - The script of the text.
- **language** (Option<&Language>) - The language of the text.
- **user_features** (&[Feature]) - A slice of user-defined features to apply.
```

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

### ShapePlan::new

Source: https://docs.rs/rustybuzz/latest/rustybuzz/struct.ShapePlan.html?search=std%3A%3Avec

Creates a new ShapePlan instance that can be used for shaping any buffer with the provided font, direction, script, language, and user features.

```APIDOC
## ShapePlan::new

### Description
Returns a plan that can be used for shaping any buffer with the provided properties.

### Signature
`pub fn new(face: &hb_font_t<'_>, direction: Direction, script: Option<Script>, language: Option<&Language>, user_features: &[Feature]) -> Self`

### Parameters
- **face** (&hb_font_t<'_>) - The font face to use for shaping.
- **direction** (Direction) - The text direction.
- **script** (Option<Script>) - The script of the text.
- **language** (Option<&Language>) - The language of the text.
- **user_features** (&[Feature]) - A slice of features to apply during shaping.
```

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

### BufferFlags Methods

Source: https://docs.rs/rustybuzz/latest/rustybuzz/struct.BufferFlags.html?search=std%3A%3Avec

A collection of methods for manipulating and querying BufferFlags instances.

```APIDOC
## BufferFlags Methods

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

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

### bits() -> u32
Returns the underlying bits value.

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

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

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

### from_name(name: &str) -> Option<Self>
Returns a flags value with the bits of a flag with the given name set.

### is_empty() -> bool
Checks if all bits are unset.

### is_all() -> bool
Checks if all known bits are set.

### intersects(other: Self) -> bool
Checks if any set bits in a source flags value are also set in a target flags value.

### contains(other: Self) -> bool
Checks if all set bits in a source flags value are also set in a target flags value.

### insert(&mut self, other: Self)
Performs bitwise OR on the flags.

### remove(&mut self, other: Self)
Performs bitwise intersection with the complement of a target flags value.

### toggle(&mut self, other: Self)
Performs bitwise XOR on the flags.

### set(&mut self, other: Self, value: bool)
Inserts or removes flags based on the provided boolean value.

### intersection(self, other: Self) -> Self
Performs bitwise AND on the flags.

### union(self, other: Self) -> Self
Performs bitwise OR on the flags.

### difference(self, other: Self) -> Self
Performs bitwise difference on the flags.

### symmetric_difference(self, other: Self) -> Self
Performs bitwise XOR on the flags.

### complement() -> Self
Performs bitwise negation on the flags.

### iter() -> Iter<BufferFlags>
Yields a set of contained flags values.

### iter_names() -> IterNames<BufferFlags>
Yields a set of contained named flags values.
```

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

### Create a new ShapePlan

Source: https://docs.rs/rustybuzz/latest/rustybuzz/struct.ShapePlan.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Constructor for creating a new shaping plan with specific font and text properties.

```rust
pub fn new( face: &hb_font_t<'_>, direction: Direction, script: Option<Script>, language: Option<&Language>, user_features: &[Feature], ) -> Self
```

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

### Outline a Glyph

Source: https://docs.rs/rustybuzz/latest/rustybuzz/struct.Face.html?search=std%3A%3Avec

Demonstrates how to implement the OutlineBuilder trait to capture glyph path segments and retrieve the tight bounding box.

```rust
use std::fmt::Write;
use ttf_parser;

struct Builder(String);

impl ttf_parser::OutlineBuilder for Builder {
    fn move_to(&mut self, x: f32, y: f32) {
        write!(&mut self.0, "M {} {} ", x, y).unwrap();
    }

    fn line_to(&mut self, x: f32, y: f32) {
        write!(&mut self.0, "L {} {} ", x, y).unwrap();
    }

    fn quad_to(&mut self, x1: f32, y1: f32, x: f32, y: f32) {
        write!(&mut self.0, "Q {} {} {} {} ", x1, y1, x, y).unwrap();
    }

    fn curve_to(&mut self, x1: f32, y1: f32, x2: f32, y2: f32, x: f32, y: f32) {
        write!(&mut self.0, "C {} {} {} {} {} {} ", x1, y1, x2, y2, x, y).unwrap();
    }

    fn close(&mut self) {
        write!(&mut self.0, "Z ").unwrap();
    }
}

let data = std::fs::read("tests/fonts/demo.ttf").unwrap();
let face = ttf_parser::Face::parse(&data, 0).unwrap();
let mut builder = Builder(String::new());
let bbox = face.outline_glyph(ttf_parser::GlyphId(1), &mut builder).unwrap();
assert_eq!(builder.0, "M 173 267 L 369 267 L 270 587 L 173 267 Z M 6 0 L 224 656 \
                       L 320 656 L 541 0 L 452 0 L 390 200 L 151 200 L 85 0 L 6 0 Z ");
assert_eq!(bbox, ttf_parser::Rect { x_min: 6, y_min: 0, x_max: 541, y_max: 656 });
```

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

### ShapePlan::new

Source: https://docs.rs/rustybuzz/latest/rustybuzz/struct.ShapePlan.html?search=

Creates a new ShapePlan that can be used for shaping any buffer with the provided properties.

```APIDOC
## pub fn new(face: &hb_font_t<'_>, direction: Direction, script: Option<Script>, language: Option<&Language>, user_features: &[Feature]) -> Self

### Description
Returns a plan that can be used for shaping any buffer with the provided properties.

### Parameters
- **face** (&hb_font_t<'_>) - Required - The font face to use for shaping.
- **direction** (Direction) - Required - The text direction.
- **script** (Option<Script>) - Required - The script of the text.
- **language** (Option<&Language>) - Required - The language of the text.
- **user_features** (&[Feature]) - Required - A slice of user-defined features to apply.
```

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

### ShapePlan::new

Source: https://docs.rs/rustybuzz/latest/rustybuzz/struct.ShapePlan.html?search=u32+-%3E+bool

Creates a new ShapePlan that can be used for shaping any buffer with the provided font, direction, script, language, and user features.

```APIDOC
## ShapePlan::new

### Description
Returns a plan that can be used for shaping any buffer with the provided properties.

### Signature
`pub fn new(face: &hb_font_t<'_>, direction: Direction, script: Option<Script>, language: Option<&Language>, user_features: &[Feature]) -> Self`

### Parameters
- **face** (&hb_font_t) - The font to be used for shaping.
- **direction** (Direction) - The text direction.
- **script** (Option<Script>) - The script of the text.
- **language** (Option<&Language>) - The language of the text.
- **user_features** (&[Feature]) - A slice of features to apply during shaping.
```

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

### BufferFlags Methods

Source: https://docs.rs/rustybuzz/latest/rustybuzz/struct.BufferFlags.html?search=

A collection of methods for manipulating and querying BufferFlags bitfields.

```APIDOC
## BufferFlags Methods

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

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

### bits() -> u32
Returns the underlying bits value.

### from_bits(bits: u32) -> Option<Self>
Converts from a bits value, returning None if unknown bits are set.

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

### from_name(name: &str) -> Option<Self>
Returns a flags value with the bits of a flag with the given name set.

### is_empty() -> bool
Checks if all bits are unset.

### contains(other: Self) -> bool
Checks if all set bits in the source are also set in the target.

### insert(&mut self, other: Self)
Performs a bitwise OR operation to insert flags.

### remove(&mut self, other: Self)
Performs a bitwise intersection with the complement to remove flags.

### toggle(&mut self, other: Self)
Performs a bitwise XOR operation to toggle flags.

### iter() -> Iter<BufferFlags>
Yields a set of contained flags values, including unknown bits as a final value.
```

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

### UnicodeBuffer Methods

Source: https://docs.rs/rustybuzz/latest/rustybuzz/struct.UnicodeBuffer.html

Methods available for interacting with and configuring a UnicodeBuffer instance.

```APIDOC
## pub fn new() -> UnicodeBuffer

### Description
Creates a new, empty UnicodeBuffer instance.

## pub fn push_str(&mut self, str: &str)

### Description
Pushes a string into the buffer for shaping.

## pub fn set_direction(&mut self, direction: Direction)

### Description
Sets the text direction for the buffer contents.

## pub fn set_script(&mut self, script: Script)

### Description
Sets the script for the buffer using an ISO15924 tag.

## pub fn set_language(&mut self, lang: Language)

### Description
Sets the language for the buffer.

## pub fn guess_segment_properties(&mut self)

### Description
Automatically determines the segment properties (direction, language, script) for the current buffer contents.

## pub fn clear(&mut self)

### Description
Removes all contents from the buffer.
```

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

### impl FromStr for Language

Source: https://docs.rs/rustybuzz/latest/rustybuzz/struct.Language.html?search=std%3A%3Avec

Allows parsing a string into a Language instance.

```APIDOC
## fn from_str(s: &str) -> Result<Self, Self::Err>

### Description
Parses a string `s` to return a value of this type.

### Signature
`fn from_str(s: &str) -> Result<Self, Self::Err>`
```

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

### Face Metrics Methods

Source: https://docs.rs/rustybuzz/latest/rustybuzz/struct.Face.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Methods for retrieving font-wide metrics and permissions.

```APIDOC
## units_per_em()
Returns the face's units per EM, guaranteed to be in the range 16..=16384.

## x_height()
Returns the face's x-height, affected by variation axes. Returns None if the OS/2 table is missing or version < 2.

## capital_height()
Returns the face's capital height, affected by variation axes. Returns None if the OS/2 table is missing or version < 2.

## underline_metrics()
Returns the face's underline metrics, affected by variation axes. Returns None if the 'post' table is missing.

## strikeout_metrics()
Returns the face's strikeout metrics, affected by variation axes. Returns None if the OS/2 table is missing.

## subscript_metrics()
Returns the face's subscript metrics, affected by variation axes. Returns None if the OS/2 table is missing.

## superscript_metrics()
Returns the face's superscript metrics, affected by variation axes. Returns None if the OS/2 table is missing.

## permissions()
Returns face permissions, or None if the value is malformed.

## is_subsetting_allowed()
Checks if the face allows embedding a subset.

## is_outline_embedding_allowed()
Checks if the face allows outline data to be embedded.
```

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

### Feature::new

Source: https://docs.rs/rustybuzz/latest/rustybuzz/struct.Feature.html?search=

Creates a new Feature instance with a specified tag, value, and range.

```APIDOC
## pub fn new(tag: Tag, value: u32, range: impl RangeBounds<usize>) -> Feature

### Description
Creates a new `Feature` struct with the provided tag, value, and range bounds.

### Parameters
- **tag** (Tag) - The OpenType feature tag.
- **value** (u32) - The value to set for the feature.
- **range** (impl RangeBounds<usize>) - The range of the input text to apply the feature to.
```

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

### Feature::new

Source: https://docs.rs/rustybuzz/latest/rustybuzz/struct.Feature.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Creates a new Feature instance with a specified tag, value, and range.

```APIDOC
## Feature::new(tag: Tag, value: u32, range: impl RangeBounds<usize>) -> Feature

### Description
Creates a new `Feature` struct with the provided tag, value, and range bounds.

### Parameters
- **tag** (Tag) - The feature tag.
- **value** (u32) - The feature value.
- **range** (impl RangeBounds<usize>) - The range of the input to which the feature applies.
```

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

### Feature::new

Source: https://docs.rs/rustybuzz/latest/rustybuzz/struct.Feature.html?search=std%3A%3Avec

Creates a new Feature instance with a specified tag, value, and range.

```APIDOC
## pub fn new(tag: Tag, value: u32, range: impl RangeBounds<usize>) -> Feature

### Description
Creates a new `Feature` struct with the provided tag, value, and range bounds.

### Parameters
- **tag** (Tag) - The OpenType feature tag.
- **value** (u32) - The value to set for the feature.
- **range** (impl RangeBounds<usize>) - The range of the input string where the feature should be applied.
```

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

### serialize()

Source: https://docs.rs/rustybuzz/latest/rustybuzz/struct.GlyphBuffer.html?search=

Converts the glyph buffer content into a string representation.

```APIDOC
### pub fn serialize(&self, face: &hb_font_t<'_>, flags: SerializeFlags) -> String

Converts the glyph buffer content into a string.
```

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

### serialize()

Source: https://docs.rs/rustybuzz/latest/rustybuzz/struct.GlyphBuffer.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Converts the glyph buffer content into a string based on the provided font and serialization flags.

```APIDOC
## pub fn serialize(&self, face: &hb_font_t<'_>, flags: SerializeFlags) -> String

### Description
Converts the glyph buffer content into a string.
```

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

### HATRAN Constant Definition

Source: https://docs.rs/rustybuzz/latest/rustybuzz/script/constant.HATRAN.html

Represents the HATRAN script constant.

```rust
pub const HATRAN: Script;
```

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

### Language::from_str

Source: https://docs.rs/rustybuzz/latest/rustybuzz/struct.Language.html

Parses a string to return a Language instance.

```APIDOC
## pub fn from_str(s: &str) -> Result<Self, Self::Err>

### Description
Parses a string `s` to return a value of this type.

### Parameters
- **s** (&str) - Required - The string representation of the language.

### Returns
- **Result<Self, Self::Err>** - Returns the parsed Language or an error if parsing fails.
```

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

### Accessing the SIGNWRITING constant

Source: https://docs.rs/rustybuzz/latest/rustybuzz/script/constant.SIGNWRITING.html

Displays the definition of the SIGNWRITING constant in the rustybuzz::script module.

```rust
pub const SIGNWRITING: Script;
```

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

### Access PHOENICIAN script constant

Source: https://docs.rs/rustybuzz/latest/rustybuzz/script/constant.PHOENICIAN.html

Represents the Phoenician script within the rustybuzz library.

```rust
pub const PHOENICIAN: Script;
```

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

### Accessing the CYPRO_MINOAN constant

Source: https://docs.rs/rustybuzz/latest/rustybuzz/script/constant.CYPRO_MINOAN.html

Represents the Cypro-Minoan script constant in the rustybuzz library.

```rust
pub const CYPRO_MINOAN: Script;
```

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

### Accessing SCRIPT_MATH Constant

Source: https://docs.rs/rustybuzz/latest/rustybuzz/script/constant.SCRIPT_MATH.html

Displays the definition of the SCRIPT_MATH constant.

```rust
pub const SCRIPT_MATH: Script;
```

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

### Accessing the HANGUL constant

Source: https://docs.rs/rustybuzz/latest/rustybuzz/script/constant.HANGUL.html

Displays the definition of the HANGUL constant in the rustybuzz::script module.

```rust
pub const HANGUL: Script;
```

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

### Accessing the ETHIOPIC script constant

Source: https://docs.rs/rustybuzz/latest/rustybuzz/script/constant.ETHIOPIC.html

Represents the Ethiopic script within the rustybuzz library.

```rust
pub const ETHIOPIC: Script;
```

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

### Accessing the GUNJALA_GONDI constant

Source: https://docs.rs/rustybuzz/latest/rustybuzz/script/constant.GUNJALA_GONDI.html

Represents the Gunjala Gondi script constant definition.

```rust
pub const GUNJALA_GONDI: Script;
```

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

### shape_with_plan

Source: https://docs.rs/rustybuzz/latest/rustybuzz/index.html

Shapes the buffer content using the provided font and plan.

```APIDOC
## shape_with_plan

### Description
Shapes the buffer content using the provided font and plan.

### Signature
`pub fn shape_with_plan(face: &Face, plan: &ShapePlan, buffer: &mut UnicodeBuffer)`
```

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

### shape_with_plan

Source: https://docs.rs/rustybuzz/latest/rustybuzz/index.html?search=

Shapes the buffer content using the provided font and plan.

```APIDOC
## shape_with_plan

### Description
Shapes the buffer content using the provided font and plan.

### Signature
`pub fn shape_with_plan(face: &Face, plan: &ShapePlan, buffer: &mut UnicodeBuffer) -> GlyphBuffer`
```

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

### Accessing the OLD_PERSIAN constant

Source: https://docs.rs/rustybuzz/latest/rustybuzz/script/constant.OLD_PERSIAN.html

Represents the Old Persian script in the rustybuzz library.

```rust
pub const OLD_PERSIAN: Script;
```

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

### TAKRI Constant Definition

Source: https://docs.rs/rustybuzz/latest/rustybuzz/script/constant.TAKRI.html

Represents the TAKRI script constant.

```rust
pub const TAKRI: Script;
```

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

### Accessing MYANMAR_ZAWGYI constant

Source: https://docs.rs/rustybuzz/latest/rustybuzz/script/constant.MYANMAR_ZAWGYI.html

Displays the definition of the MYANMAR_ZAWGYI constant.

```rust
pub const MYANMAR_ZAWGYI: Script;
```

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

### Feature::new

Source: https://docs.rs/rustybuzz/latest/rustybuzz/struct.Feature.html

Creates a new Feature struct with a specified tag, value, and range.

```APIDOC
### pub fn new(tag: Tag, value: u32, range: impl RangeBounds<usize>) -> Feature

Creates a new `Feature` struct with the provided tag, value, and range bounds.
```

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

### BufferFlags Methods

Source: https://docs.rs/rustybuzz/latest/rustybuzz/struct.BufferFlags.html?search=u32+-%3E+bool

Methods available on the BufferFlags struct for bitwise operations and flag management.

```APIDOC
## BufferFlags Methods

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

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

### bits() -> u32
Returns the underlying bits value.

### from_bits(bits: u32) -> Option<Self>
Converts from a bits value, returning None if unknown bits are set.

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

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

### from_name(name: &str) -> Option<Self>
Returns a flags value with the bits of a flag with the given name set.

### is_empty() -> bool
Checks if all bits are unset.

### is_all() -> bool
Checks if all known bits are set.

### intersects(other: Self) -> bool
Checks if any set bits in a source flags value are also set in a target flags value.

### contains(other: Self) -> bool
Checks if all set bits in a source flags value are also set in a target flags value.

### insert(&mut self, other: Self)
Performs bitwise OR on the flags.

### remove(&mut self, other: Self)
Performs bitwise intersection with the complement of a target flags value.

### toggle(&mut self, other: Self)
Performs bitwise XOR on the flags.

### set(&mut self, other: Self, value: bool)
Inserts or removes flags based on the provided boolean value.

### intersection(self, other: Self) -> Self
Returns the bitwise AND of two flags values.

### union(self, other: Self) -> Self
Returns the bitwise OR of two flags values.

### difference(self, other: Self) -> Self
Returns the difference of two flags values.

### symmetric_difference(self, other: Self) -> Self
Returns the bitwise XOR of two flags values.

### complement() -> Self
Returns the bitwise negation of the flags value.

### iter() -> Iter<BufferFlags>
Yields a set of contained flags values.

### iter_names() -> IterNames<BufferFlags>
Yields a set of contained named flags values.
```

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

### Accessing the YI constant

Source: https://docs.rs/rustybuzz/latest/rustybuzz/script/constant.YI.html

Represents the YI script constant definition.

```rust
pub const YI: Script;
```

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

### Define KHITAN_SMALL_SCRIPT constant

Source: https://docs.rs/rustybuzz/latest/rustybuzz/script/constant.KHITAN_SMALL_SCRIPT.html?search=

Represents the constant definition for the Khitan small script within the rustybuzz::script module.

```rust
pub const KHITAN_SMALL_SCRIPT: Script;
```

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

### Language::as_str

Source: https://docs.rs/rustybuzz/latest/rustybuzz/struct.Language.html

Returns the language as a string slice.

```APIDOC
## pub fn as_str(&self) -> &str

### Description
Returns the language as a string.

### Signature
`pub fn as_str(&self) -> &str`
```

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

### Define VAI constant

Source: https://docs.rs/rustybuzz/latest/rustybuzz/script/constant.VAI.html

Represents the VAI script constant definition.

```rust
pub const VAI: Script;
```

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

### Access the BOPOMOFO constant

Source: https://docs.rs/rustybuzz/latest/rustybuzz/script/constant.BOPOMOFO.html

Represents the BOPOMOFO script type in the rustybuzz library.

```rust
pub const BOPOMOFO: Script;
```

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

### shape_with_plan

Source: https://docs.rs/rustybuzz/latest/rustybuzz/fn.shape_with_plan.html

Shapes the buffer content using the provided font and plan. Consumes the buffer and returns a GlyphBuffer.

```APIDOC
## pub fn shape_with_plan(face: &hb_font_t<'_>, plan: &hb_ot_shape_plan_t, buffer: UnicodeBuffer) -> GlyphBuffer

### Description
Shapes the buffer content using the provided font and plan. This function consumes the buffer; you can run `GlyphBuffer::clear` to retrieve the `UnicodeBuffer` without reallocating.

### Parameters
- **face** (&hb_font_t) - The font used for shaping.
- **plan** (&hb_ot_shape_plan_t) - The shaping plan to apply.
- **buffer** (UnicodeBuffer) - The buffer containing the text to be shaped.

### Returns
- **GlyphBuffer** - The resulting shaped glyphs.

### Panics
Will panic when debugging assertions are enabled if the buffer and plan have mismatched properties.
```

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

### shape_with_plan

Source: https://docs.rs/rustybuzz/latest/rustybuzz/fn.shape_with_plan.html?search=u32+-%3E+bool

Shapes the buffer content using the provided font and plan. Consumes the buffer and returns a GlyphBuffer.

```APIDOC
## Function: shape_with_plan

### Signature
`pub fn shape_with_plan(face: &hb_font_t<'_>, plan: &hb_ot_shape_plan_t, buffer: UnicodeBuffer) -> GlyphBuffer`

### Description
Shapes the buffer content using the provided font and plan. This function consumes the buffer. You can run `GlyphBuffer::clear` to retrieve the `UnicodeBuffer` without allocating a new one.

### Notes
- It is the caller's responsibility to ensure the shape plan matches the properties of the provided buffer.
- Will panic when debugging assertions are enabled if the buffer and plan have mismatched properties.
```

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

### BufferFlags Methods

Source: https://docs.rs/rustybuzz/latest/rustybuzz/struct.BufferFlags.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Methods for manipulating and querying BufferFlags bit-flag values.

```APIDOC
## BufferFlags Methods

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

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

### bits()
Returns the underlying u32 bits value.

### from_bits(bits: u32) -> Option<Self>
Converts from a bits value, returning None if unknown bits are set.

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

### from_name(name: &str) -> Option<Self>
Returns a flags value corresponding to the given flag name.

### contains(other: Self) -> bool
Checks if all set bits in the target are present in the source.

### insert(&mut self, other: Self)
Performs a bitwise OR operation to add flags.

### remove(&mut self, other: Self)
Performs a bitwise AND NOT operation to remove flags.
```

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

### Accessing the MYANMAR constant

Source: https://docs.rs/rustybuzz/latest/rustybuzz/script/constant.MYANMAR.html

Represents the Myanmar script in the rustybuzz library.

```rust
pub const MYANMAR: Script;
```

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

### glyph_infos()

Source: https://docs.rs/rustybuzz/latest/rustybuzz/struct.GlyphBuffer.html?search=

Retrieves the glyph information stored in the buffer.

```APIDOC
### pub fn glyph_infos(&self) -> &[hb_glyph_info_t]

Get the glyph infos.
```

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

### glyph_infos()

Source: https://docs.rs/rustybuzz/latest/rustybuzz/struct.GlyphBuffer.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Retrieves the glyph information stored in the buffer.

```APIDOC
## pub fn glyph_infos(&self) -> &[hb_glyph_info_t]

### Description
Get the glyph infos.
```

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

### Define Script struct

Source: https://docs.rs/rustybuzz/latest/rustybuzz/struct.Script.html?search=std%3A%3Avec

The definition of the Script struct.

```rust
pub struct Script(/* private fields */);
```

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

### Feature::new

Source: https://docs.rs/rustybuzz/latest/rustybuzz/struct.Feature.html?search=u32+-%3E+bool

Creates a new Feature struct with the specified tag, value, and range.

```APIDOC
## pub fn new(tag: Tag, value: u32, range: impl RangeBounds<usize>) -> Feature

### Description
Creates a new `Feature` struct instance.

### Parameters
- **tag** (Tag) - The feature tag.
- **value** (u32) - The feature value.
- **range** (impl RangeBounds<usize>) - The range specifying on which subslice of input the feature should be applied.
```

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

### Accessing the UNKNOWN script constant

Source: https://docs.rs/rustybuzz/latest/rustybuzz/script/constant.UNKNOWN.html

Represents an undefined script type. Use this constant when a script cannot be identified.

```rust
pub const UNKNOWN: Script;
```

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

### len()

Source: https://docs.rs/rustybuzz/latest/rustybuzz/struct.GlyphBuffer.html?search=

Returns the length of the data in the buffer. Before shaping, this is the number of unicode codepoints; after shaping, it is the number of glyphs.

```APIDOC
### pub fn len(&self) -> usize

Returns the length of the data of the buffer. When called before shaping this is the number of unicode codepoints contained in the buffer. When called after shaping it returns the number of glyphs stored.
```

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

### Define OL_CHIKI constant

Source: https://docs.rs/rustybuzz/latest/rustybuzz/script/constant.OL_CHIKI.html?search=

Represents the OL_CHIKI script constant definition.

```rust
pub const OL_CHIKI: Script;
```

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

### Define TULU_TIGALARI constant

Source: https://docs.rs/rustybuzz/latest/rustybuzz/script/constant.TULU_TIGALARI.html

Represents the Tulu-Tigalari script constant.

```rust
pub const TULU_TIGALARI: Script;
```

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

### is_empty()

Source: https://docs.rs/rustybuzz/latest/rustybuzz/struct.GlyphBuffer.html?search=

Checks if the buffer contains no elements.

```APIDOC
### pub fn is_empty(&self) -> bool

Returns `true` if the buffer contains no elements.
```

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

### is_empty()

Source: https://docs.rs/rustybuzz/latest/rustybuzz/struct.GlyphBuffer.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Checks if the buffer contains no elements.

```APIDOC
## pub fn is_empty(&self) -> bool

### Description
Returns true if the buffer contains no elements.
```

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

### color_palettes

Source: https://docs.rs/rustybuzz/latest/rustybuzz/struct.Face.html?search=u32+-%3E+bool

Returns the number of available color palettes.

```APIDOC
## pub fn color_palettes(&self) -> Option<NonZero<u16>>

### Description
Returns the total number of color palettes stored within the COLR and CPAL tables of the font.
```

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

### Script::from_iso15924_tag

Source: https://docs.rs/rustybuzz/latest/rustybuzz/struct.Script.html

Converts an ISO 15924 script tag to a corresponding Script instance.

```APIDOC
## pub fn from_iso15924_tag(tag: Tag) -> Option<Script>

### Description
Converts an ISO 15924 script tag to a corresponding `Script`.

### Parameters
- **tag** (Tag) - Required - The ISO 15924 tag to convert.

### Returns
- **Option<Script>** - Returns `Some(Script)` if the tag is valid, otherwise `None`.
```

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

### Script::from_iso15924_tag

Source: https://docs.rs/rustybuzz/latest/rustybuzz/struct.Script.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Converts an ISO 15924 script tag to a corresponding Script instance.

```APIDOC
## pub fn from_iso15924_tag(tag: Tag) -> Option<Script>

### Description
Converts an ISO 15924 script tag to a corresponding `Script` object.

### Parameters
- **tag** (Tag) - Required - The ISO 15924 tag to convert.

### Returns
- **Option<Script>** - Returns `Some(Script)` if the tag is valid, otherwise `None`.
```

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

### Access SORA_SOMPENG constant

Source: https://docs.rs/rustybuzz/latest/rustybuzz/script/constant.SORA_SOMPENG.html

Represents the SORA_SOMPENG script constant definition.

```rust
pub const SORA_SOMPENG: Script;
```

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

### MIAO Constant Definition

Source: https://docs.rs/rustybuzz/latest/rustybuzz/script/constant.MIAO.html

Represents the MIAO script constant definition.

```rust
pub const MIAO: Script;
```

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

### len()

Source: https://docs.rs/rustybuzz/latest/rustybuzz/struct.GlyphBuffer.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Returns the length of the data in the buffer. Before shaping, this represents the number of unicode codepoints; after shaping, it represents the number of glyphs.

```APIDOC
## pub fn len(&self) -> usize

### Description
Returns the length of the data of the buffer. When called before shaping this is the number of unicode codepoints contained in the buffer. When called after shaping it returns the number of glyphs stored.
```

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

### Accessing the GURMUKHI constant

Source: https://docs.rs/rustybuzz/latest/rustybuzz/script/constant.GURMUKHI.html

Represents the Gurmukhi script in the rustybuzz library.

```rust
pub const GURMUKHI: Script;
```

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

### glyph_bounding_box

Source: https://docs.rs/rustybuzz/latest/rustybuzz/struct.Face.html

Returns a tight glyph bounding box. This is a shorthand for outline_glyph for glyf tables, but performs actual outlining for CFF and variable fonts.

```APIDOC
## pub fn glyph_bounding_box(&self, glyph_id: GlyphId) -> Option<Rect>

### Description
Calculates the tight bounding box for a specific glyph. Returns None if the glyph is defined by a raster or vector image.
```

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

### Script::tag

Source: https://docs.rs/rustybuzz/latest/rustybuzz/struct.Script.html

Returns the tag associated with the script.

```APIDOC
## pub fn tag(&self) -> Tag

### Description
Returns the script's tag.

### Returns
- **Tag** - The tag associated with this script.
```

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

### Accessing the TAGALOG constant

Source: https://docs.rs/rustybuzz/latest/rustybuzz/script/constant.TAGALOG.html

Use this constant to reference the Tagalog script definition in rustybuzz.

```rust
pub const TAGALOG: Script;
```

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

### Accessing the SUNUWAR constant

Source: https://docs.rs/rustybuzz/latest/rustybuzz/script/constant.SUNUWAR.html

Represents the SUNUWAR script constant definition.

```rust
pub const SUNUWAR: Script;
```

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

### LINEAR_A Constant Definition

Source: https://docs.rs/rustybuzz/latest/rustybuzz/script/constant.LINEAR_A.html

The public constant definition for the Linear A script.

```rust
pub const LINEAR_A: Script;
```

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

### Accessing the NKO constant

Source: https://docs.rs/rustybuzz/latest/rustybuzz/script/constant.NKO.html

Represents the NKO script constant used within the rustybuzz::script module.

```rust
pub const NKO: Script;
```

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

### Accessing the KATAKANA constant

Source: https://docs.rs/rustybuzz/latest/rustybuzz/script/constant.KATAKANA.html

Defines the KATAKANA constant within the rustybuzz::script module.

```rust
pub const KATAKANA: Script;
```

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

### TIFINAGH Constant Definition

Source: https://docs.rs/rustybuzz/latest/rustybuzz/script/constant.TIFINAGH.html

Represents the TIFINAGH script constant.

```rust
pub const TIFINAGH: Script;
```

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

### UnicodeBuffer Definition

Source: https://docs.rs/rustybuzz/latest/rustybuzz/struct.UnicodeBuffer.html?search=std%3A%3Avec

The internal structure definition for UnicodeBuffer.

```rust
pub struct UnicodeBuffer(/* private fields */);
```

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

### pub fn shape_with_plan

Source: https://docs.rs/rustybuzz/latest/rustybuzz/fn.shape_with_plan.html?search=std%3A%3Avec

Shapes the buffer content using the provided font and plan. Consumes the buffer, which can be reclaimed by calling GlyphBuffer::clear.

```APIDOC
## Function: shape_with_plan

### Description
Shapes the buffer content using the provided font and plan. This function consumes the buffer; the caller can subsequently run `GlyphBuffer::clear` to retrieve the `UnicodeBuffer` without additional allocation.

### Signature
`pub fn shape_with_plan(face: &hb_font_t<'_>, plan: &hb_ot_shape_plan_t, buffer: UnicodeBuffer) -> GlyphBuffer`

### Parameters
- **face** (&hb_font_t<'_>) - The font used for shaping.
- **plan** (&hb_ot_shape_plan_t) - The shaping plan to apply.
- **buffer** (UnicodeBuffer) - The buffer containing the text to be shaped.

### Returns
- **GlyphBuffer** - The resulting shaped glyphs.

### Panics
Will panic when debugging assertions are enabled if the buffer and plan have mismatched properties.
```

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

### Language Struct Definition

Source: https://docs.rs/rustybuzz/latest/rustybuzz/struct.Language.html?search=std%3A%3Avec

The primary definition of the Language struct.

```rust
pub struct Language(/* private fields */);
```

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

### PSALTER_PAHLAVI Constant Definition

Source: https://docs.rs/rustybuzz/latest/rustybuzz/script/constant.PSALTER_PAHLAVI.html

Represents the Psalter Pahlavi script constant.

```rust
pub const PSALTER_PAHLAVI: Script;
```

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

### Access the BRAILLE constant

Source: https://docs.rs/rustybuzz/latest/rustybuzz/script/constant.BRAILLE.html

Use this constant to reference the Braille script definition in rustybuzz.

```rust
pub const BRAILLE: Script;
```

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

### Accessing the UGARITIC constant

Source: https://docs.rs/rustybuzz/latest/rustybuzz/script/constant.UGARITIC.html

Represents the Ugaritic script constant for use in script-related operations.

```rust
pub const UGARITIC: Script;
```

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

### Accessing the NEW_TAI_LUE constant

Source: https://docs.rs/rustybuzz/latest/rustybuzz/script/constant.NEW_TAI_LUE.html

Represents the New Tai Lue script constant within the rustybuzz::script module.

```rust
pub const NEW_TAI_LUE: Script;
```

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

### Accessing the MODI constant

Source: https://docs.rs/rustybuzz/latest/rustybuzz/script/constant.MODI.html?search=

Defines the MODI constant as a Script type.

```rust
pub const MODI: Script;
```

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

### clear()

Source: https://docs.rs/rustybuzz/latest/rustybuzz/struct.GlyphBuffer.html?search=

Clears the content of the glyph buffer and returns an empty UnicodeBuffer, reusing the existing allocation.

```APIDOC
### pub fn clear(self) -> UnicodeBuffer

Clears the content of the glyph buffer and returns an empty `UnicodeBuffer` reusing the existing allocation.
```

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

### clear()

Source: https://docs.rs/rustybuzz/latest/rustybuzz/struct.GlyphBuffer.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Clears the content of the glyph buffer and returns an empty UnicodeBuffer, reusing the existing allocation.

```APIDOC
## pub fn clear(self) -> UnicodeBuffer

### Description
Clears the content of the glyph buffer and returns an empty UnicodeBuffer reusing the existing allocation.
```

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

### HANUNOO Constant Definition

Source: https://docs.rs/rustybuzz/latest/rustybuzz/script/constant.HANUNOO.html

Represents the Hanunoo script constant.

```rust
pub const HANUNOO: Script;
```

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

### Define ShapePlan struct

Source: https://docs.rs/rustybuzz/latest/rustybuzz/struct.ShapePlan.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

The internal structure definition for ShapePlan.

```rust
pub struct ShapePlan { /* private fields */ }
```

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

### Define KANNADA Script Constant

Source: https://docs.rs/rustybuzz/latest/rustybuzz/script/constant.KANNADA.html?search=

Represents the KANNADA script constant within the rustybuzz::script module.

```rust
pub const KANNADA: Script;
```

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

### Define MENDE_KIKAKUI constant

Source: https://docs.rs/rustybuzz/latest/rustybuzz/script/constant.MENDE_KIKAKUI.html

Represents the Mende Kikakui script constant.

```rust
pub const MENDE_KIKAKUI: Script;
```

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

### glyph_bounding_box

Source: https://docs.rs/rustybuzz/latest/rustybuzz/struct.Face.html?search=u32+-%3E+bool

Returns a tight bounding box for a specific glyph.

```APIDOC
## pub fn glyph_bounding_box(&self, glyph_id: GlyphId) -> Option<Rect>

### Description
Calculates and returns a tight bounding box for the specified glyph. For CFF and variable fonts, this method performs an outline operation to determine the bounds. Returns `None` if the glyph is defined by a raster or vector image.
```

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

### Access TANGUT Script Constant

Source: https://docs.rs/rustybuzz/latest/rustybuzz/script/constant.TANGUT.html

Represents the Tangut script constant within the rustybuzz::script module.

```rust
pub const TANGUT: Script;
```

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

### Define GURUNG_KHEMA constant

Source: https://docs.rs/rustybuzz/latest/rustybuzz/script/constant.GURUNG_KHEMA.html?search=

Represents the GURUNG_KHEMA script constant in the rustybuzz library.

```rust
pub const GURUNG_KHEMA: Script;
```

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

### Script::tag

Source: https://docs.rs/rustybuzz/latest/rustybuzz/struct.Script.html?search=u32+-%3E+bool

Retrieves the tag associated with the Script.

```APIDOC
## pub fn tag(&self) -> Tag

### Description
Returns the script's tag.

### Returns
- **Tag** - The tag associated with this script instance.
```

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

### Glyph Access Methods

Source: https://docs.rs/rustybuzz/latest/rustybuzz/struct.Face.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Methods for resolving glyph IDs and retrieving glyph-specific metrics.

```APIDOC
## number_of_glyphs()
Returns the total number of glyphs in the face.

## glyph_index(code_point: char)
Resolves a Glyph ID for a given code point. Returns None if not found.

## glyph_index_by_name(name: &str)
Resolves a Glyph ID for a given glyph name using 'post' and 'CFF' tables.

## glyph_variation_index(code_point: char, variation: char)
Resolves a variation of a Glyph ID from two code points.

## glyph_hor_advance(glyph_id: GlyphId)
Returns the horizontal advance for a glyph, affected by variation axes.

## glyph_ver_advance(glyph_id: GlyphId)
Returns the vertical advance for a glyph, affected by variation axes.

## glyph_hor_side_bearing(glyph_id: GlyphId)
Returns the horizontal side bearing for a glyph, affected by variation axes.

## glyph_ver_side_bearing(glyph_id: GlyphId)
Returns the vertical side bearing for a glyph, affected by variation axes.

## glyph_y_origin(glyph_id: GlyphId)
Returns the vertical origin for a glyph, affected by variation axes.

## glyph_name(glyph_id: GlyphId)
Returns the name of a glyph using 'post' and 'CFF' tables.
```

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

### ELBASAN Constant Definition

Source: https://docs.rs/rustybuzz/latest/rustybuzz/script/constant.ELBASAN.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

The public constant definition for ELBASAN in the rustybuzz::script module.

```rust
pub const ELBASAN: Script;
```

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

### global_bounding_box

Source: https://docs.rs/rustybuzz/latest/rustybuzz/struct.Face.html

Returns a bounding box large enough to enclose any glyph from the face.

```APIDOC
## pub fn global_bounding_box(&self) -> Rect

### Description
Returns the global bounding box for the entire font face.
```

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

### KAYAH_LI Constant Definition

Source: https://docs.rs/rustybuzz/latest/rustybuzz/script/constant.KAYAH_LI.html

Represents the KAYAH_LI script constant used in rustybuzz.

```rust
pub const KAYAH_LI: Script;
```

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

### GlyphBuffer Definition

Source: https://docs.rs/rustybuzz/latest/rustybuzz/struct.GlyphBuffer.html

The internal structure definition for GlyphBuffer.

```rust
pub struct GlyphBuffer(/* private fields */);
```

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

### Access the MEETEI_MAYEK constant

Source: https://docs.rs/rustybuzz/latest/rustybuzz/script/constant.MEETEI_MAYEK.html

Represents the Meetei Mayek script type within the rustybuzz library.

```rust
pub const MEETEI_MAYEK: Script;
```

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

### Access OGHAM constant

Source: https://docs.rs/rustybuzz/latest/rustybuzz/script/constant.OGHAM.html?search=

Represents the Ogham script constant used within the rustybuzz::script module.

```rust
pub const OGHAM: Script;
```

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

### Accessing the CYPRIOT constant

Source: https://docs.rs/rustybuzz/latest/rustybuzz/script/constant.CYPRIOT.html

Use this constant to reference the Cypriot script type within the rustybuzz library.

```rust
pub const CYPRIOT: Script;
```

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

### Accessing the BUHID constant

Source: https://docs.rs/rustybuzz/latest/rustybuzz/script/constant.BUHID.html?search=

Defines the BUHID constant as a Script type.

```rust
pub const BUHID: Script;
```

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

### Accessing the MULTANI Script Constant

Source: https://docs.rs/rustybuzz/latest/rustybuzz/script/constant.MULTANI.html

Use this constant to reference the Multani script in text shaping operations.

```rust
pub const MULTANI: Script;
```

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

### Access MEROITIC_CURSIVE constant

Source: https://docs.rs/rustybuzz/latest/rustybuzz/script/constant.MEROITIC_CURSIVE.html

Represents the Meroitic Cursive script constant.

```rust
pub const MEROITIC_CURSIVE: Script;
```

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

### Accessing the OLD_UYGHUR constant

Source: https://docs.rs/rustybuzz/latest/rustybuzz/script/constant.OLD_UYGHUR.html

Represents the Old Uyghur script identifier in the rustybuzz library.

```rust
pub const OLD_UYGHUR: Script;
```

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

### Access GLAGOLITIC constant

Source: https://docs.rs/rustybuzz/latest/rustybuzz/script/constant.GLAGOLITIC.html

Represents the Glagolitic script in the rustybuzz::script module.

```rust
pub const GLAGOLITIC: Script;
```

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

### Define TAMIL script constant

Source: https://docs.rs/rustybuzz/latest/rustybuzz/script/constant.TAMIL.html

Represents the Tamil script constant within the rustybuzz::script module.

```rust
pub const TAMIL: Script;
```

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

### Define MALAYALAM script constant

Source: https://docs.rs/rustybuzz/latest/rustybuzz/script/constant.MALAYALAM.html?search=

Represents the Malayalam script constant within the rustybuzz::script module.

```rust
pub const MALAYALAM: Script;
```

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

### SYRIAC Constant Definition

Source: https://docs.rs/rustybuzz/latest/rustybuzz/script/constant.SYRIAC.html

Represents the Syriac script constant in the rustybuzz library.

```rust
pub const SYRIAC: Script;
```

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

### Define MAHAJANI Script Constant

Source: https://docs.rs/rustybuzz/latest/rustybuzz/script/constant.MAHAJANI.html

Represents the Mahajani script constant within the rustybuzz::script module.

```rust
pub const MAHAJANI: Script;
```

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

### shape_with_plan

Source: https://docs.rs/rustybuzz/latest/rustybuzz/fn.shape_with_plan.html?search=

Shapes the buffer content using the provided font and plan. Consumes the buffer, which can be reclaimed via GlyphBuffer::clear.

```APIDOC
## Function: shape_with_plan

### Description
Shapes the buffer content using the provided font and plan. This function consumes the buffer; the caller can subsequently run `GlyphBuffer::clear` to retrieve the `UnicodeBuffer` without additional allocation. The caller must ensure the shape plan matches the buffer properties to avoid incorrect shaping results.

### Signature
`pub fn shape_with_plan(face: &hb_font_t<'_>, plan: &hb_ot_shape_plan_t, buffer: UnicodeBuffer) -> GlyphBuffer`

### Parameters
- **face** (&hb_font_t) - The font used for shaping.
- **plan** (&hb_ot_shape_plan_t) - The shape plan to apply.
- **buffer** (UnicodeBuffer) - The buffer containing the text to be shaped.

### Returns
- **GlyphBuffer** - The resulting shaped glyph buffer.

### Panics
Will panic when debugging assertions are enabled if the buffer and plan have mismatched properties.
```

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

### shape_with_plan

Source: https://docs.rs/rustybuzz/latest/rustybuzz/fn.shape_with_plan.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Shapes the buffer content using the provided font and plan. Consumes the buffer, which can be reclaimed via GlyphBuffer::clear.

```APIDOC
## Function: shape_with_plan

### Description
Shapes the buffer content using the provided font and plan. This function consumes the buffer; the caller can subsequently run `GlyphBuffer::clear` to retrieve the `UnicodeBuffer` without additional allocation. The caller must ensure the shape plan matches the buffer properties.

### Signature
`pub fn shape_with_plan(face: &hb_font_t<'_>, plan: &hb_ot_shape_plan_t, buffer: UnicodeBuffer) -> GlyphBuffer`

### Parameters
- **face** (&hb_font_t<'_>) - The font to use for shaping.
- **plan** (&hb_ot_shape_plan_t) - The shaping plan to apply.
- **buffer** (UnicodeBuffer) - The buffer containing the text to be shaped.

### Returns
- **GlyphBuffer** - The resulting shaped glyphs.

### Panics
- Will panic when debugging assertions are enabled if the buffer and plan have mismatched properties.
```

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

### CUNEIFORM Script Constant Definition

Source: https://docs.rs/rustybuzz/latest/rustybuzz/script/constant.CUNEIFORM.html

Represents the CUNEIFORM script constant in the rustybuzz::script module.

```rust
pub const CUNEIFORM: Script;
```

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

### Define KIRAT_RAI constant

Source: https://docs.rs/rustybuzz/latest/rustybuzz/script/constant.KIRAT_RAI.html

Represents the KIRAT_RAI script constant used within the rustybuzz::script module.

```rust
pub const KIRAT_RAI: Script;
```

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

### TAI_VIET Constant Definition

Source: https://docs.rs/rustybuzz/latest/rustybuzz/script/constant.TAI_VIET.html

Represents the Tai Viet script constant.

```rust
pub const TAI_VIET: Script;
```

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

### Accessing the GUJARATI constant

Source: https://docs.rs/rustybuzz/latest/rustybuzz/script/constant.GUJARATI.html

Use this constant to identify or specify the Gujarati script in text processing tasks.

```rust
pub const GUJARATI: Script;
```

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

### AVESTAN Constant Definition

Source: https://docs.rs/rustybuzz/latest/rustybuzz/script/constant.AVESTAN.html

Represents the AVESTAN script constant.

```rust
pub const AVESTAN: Script;
```

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

### Accessing the OLD_NORTH_ARABIAN constant

Source: https://docs.rs/rustybuzz/latest/rustybuzz/script/constant.OLD_NORTH_ARABIAN.html

Represents the Old North Arabian script constant.

```rust
pub const OLD_NORTH_ARABIAN: Script;
```

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

### Define KAITHI constant

Source: https://docs.rs/rustybuzz/latest/rustybuzz/script/constant.KAITHI.html?search=

Represents the Kaithi script constant in the rustybuzz library.

```rust
pub const KAITHI: Script;
```

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

### Define MANICHAEAN script constant

Source: https://docs.rs/rustybuzz/latest/rustybuzz/script/constant.MANICHAEAN.html

Represents the Manichaean script constant within the rustybuzz library.

```rust
pub const MANICHAEAN: Script;
```

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

### Accessing the NUSHU constant

Source: https://docs.rs/rustybuzz/latest/rustybuzz/script/constant.NUSHU.html

Defines the NUSHU constant as a Script type.

```rust
pub const NUSHU: Script;
```

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

### Define YEZIDI Script Constant

Source: https://docs.rs/rustybuzz/latest/rustybuzz/script/constant.YEZIDI.html?search=

Represents the YEZIDI script constant within the rustybuzz::script module.

```rust
pub const YEZIDI: Script;
```

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

### Define KHOJKI constant

Source: https://docs.rs/rustybuzz/latest/rustybuzz/script/constant.KHOJKI.html?search=

Represents the KHOJKI script constant definition.

```rust
pub const KHOJKI: Script;
```

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

### Accessing the CHAM constant

Source: https://docs.rs/rustybuzz/latest/rustybuzz/script/constant.CHAM.html

Represents the CHAM script constant definition.

```rust
pub const CHAM: Script;
```

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

### Define TOTO constant

Source: https://docs.rs/rustybuzz/latest/rustybuzz/script/constant.TOTO.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Declaration of the TOTO constant as a Script type.

```rust
pub const TOTO: Script;
```

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

### Feature Struct Definition

Source: https://docs.rs/rustybuzz/latest/rustybuzz/struct.Feature.html

The core data structure representing a feature tag and its application range.

```rust
#[repr(C)]
pub struct Feature {
    pub tag: Tag,
    pub value: u32,
    pub start: u32,
    pub end: u32,
}
```

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

### Accessing the OLD_TURKIC constant

Source: https://docs.rs/rustybuzz/latest/rustybuzz/script/constant.OLD_TURKIC.html

Represents the Old Turkic script constant within the rustybuzz::script module.

```rust
pub const OLD_TURKIC: Script;
```

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

### Accessing the VITHKUQI constant

Source: https://docs.rs/rustybuzz/latest/rustybuzz/script/constant.VITHKUQI.html

The VITHKUQI constant is defined as a Script type within the rustybuzz::script module.

```rust
pub const VITHKUQI: Script;
```

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

### shape_with_plan Function Signature

Source: https://docs.rs/rustybuzz/latest/rustybuzz/fn.shape_with_plan.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

The function signature for shaping buffer content with a provided font and plan.

```rust
pub fn shape_with_plan(
    face: &hb_font_t<'_>,
    plan: &hb_ot_shape_plan_t,
    buffer: UnicodeBuffer,
) -> GlyphBuffer
```

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

### Feature::from_str

Source: https://docs.rs/rustybuzz/latest/rustybuzz/struct.Feature.html?search=

Parses a string representation into a Feature struct.

```APIDOC
## pub fn from_str(s: &str) -> Result<Self, Self::Err>

### Description
Parses a string into a `Feature` struct. Supports various formats such as `kern`, `+kern`, `kern=0`, and range-based syntax like `kern[3:5]`.

### Parameters
- **s** (&str) - The string to parse.
```

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

### Feature::from_str

Source: https://docs.rs/rustybuzz/latest/rustybuzz/struct.Feature.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Parses a string representation into a Feature struct.

```APIDOC
## Feature::from_str(s: &str) -> Result<Self, Self::Err>

### Description
Parses a string into a `Feature` struct. Supports various formats such as 'kern', '+kern', 'kern=1', and range-based syntax like 'kern[3:5]'.

### Parameters
- **s** (&str) - The string to parse.
```

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

### Feature::from_str

Source: https://docs.rs/rustybuzz/latest/rustybuzz/struct.Feature.html?search=std%3A%3Avec

Parses a string representation into a Feature struct.

```APIDOC
## pub fn from_str(s: &str) -> Result<Self, Self::Err>

### Description
Parses a string into a `Feature` struct. Supports various formats such as `kern`, `+kern`, `-kern`, `kern=1`, and range-specific syntax like `kern[3:5]=1`.

### Parameters
- **s** (&str) - The string to parse.
```

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

### GlyphPosition Struct Definition

Source: https://docs.rs/rustybuzz/latest/rustybuzz/struct.GlyphPosition.html?search=std%3A%3Avec

Defines the structure for glyph positioning, including advance and offset fields.

```rust
pub struct GlyphPosition {
    pub x_advance: i32,
    pub y_advance: i32,
    pub x_offset: i32,
    pub y_offset: i32,
    /* private fields */
}
```

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

### Define KHMER Script Constant

Source: https://docs.rs/rustybuzz/latest/rustybuzz/script/constant.KHMER.html

Represents the Khmer script constant within the rustybuzz::script module.

```rust
pub const KHMER: Script;
```

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

### Define LAO script constant

Source: https://docs.rs/rustybuzz/latest/rustybuzz/script/constant.LAO.html

Represents the LAO script constant within the rustybuzz::script module.

```rust
pub const LAO: Script;
```
Tokens:
Raw