Ass Editor

https://docs.rs/ass-editor/0.1.1/
Admin
Ass Editor is a high-performance, ergonomic editor layer for ASS subtitles, offering an interactive...
Tokens:556,602
Snippets:3,359
Trust Score:9.7
Update:1 year ago
Show doc for...
Tokens:
Raw
### Rust Ecosystem Links

Source: https://docs.rs/ass-editor/0.1.1/src/ass_editor/commands/karaoke_commands

Provides links to essential Rust documentation and resources, including The Book, Standard Library API Reference, Rust by Example, and the Cargo Guide.

```Rust
Rust:
    * Rust website
    * The Book
    * Standard Library API Reference
    * Rust by Example
    * The Cargo Guide
    * Clippy Documentation
```

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

### Rust Ecosystem Links

Source: https://docs.rs/ass-editor/0.1.1/src/ass_editor/commands/style_commands

Provides links to essential Rust resources, including the official Rust website, The Book, Standard Library API Reference, Rust by Example, The Cargo Guide, and Clippy Documentation.

```rust
Rust:
    * [Rust website](https://www.rust-lang.org/)
    * [The Book](https://doc.rust-lang.org/book/)
    * [Standard Library API Reference](https://doc.rust-lang.org/std/)
    * [Rust by Example](https://doc.rust-lang.org/rust-by-example/)
    * [The Cargo Guide](https://doc.rust-lang.org/cargo/guide/)
    * [Clippy Documentation](https://doc.rust-lang.org/nightly/clippy)
```

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

### Rust Ecosystem Links

Source: https://docs.rs/ass-editor/0.1.1/src/ass_editor/commands/delta_commands

Provides links to essential Rust resources, including the official Rust website, The Book, Standard Library API Reference, Rust by Example, The Cargo Guide, and Clippy Documentation.

```rust
Rust Resources:
- Rust website: https://www.rust-lang.org/
- The Book: https://doc.rust-lang.org/book/
- Standard Library API Reference: https://doc.rust-lang.org/std/
- Rust by Example: https://doc.rust-lang.org/rust-by-example/
- The Cargo Guide: https://doc.rust-lang.org/cargo/guide/
- Clippy Documentation: https://doc.rust-lang.org/nightly/clippy
```

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

### Rust Documentation Resources

Source: https://docs.rs/ass-editor/0.1.1/src/ass_editor/formats/webvtt/mod

Provides links to essential Rust documentation resources, including the official website, The Book, standard library API reference, Rust by Example, Cargo Guide, and Clippy documentation.

```Rust
Rust:
    * [Rust website](https://www.rust-lang.org/)
    * [The Book](https://doc.rust-lang.org/book/)
    * [Standard Library API Reference](https://doc.rust-lang.org/std/)
    * [Rust by Example](https://doc.rust-lang.org/rust-by-example/)
    * [The Cargo Guide](https://doc.rust-lang.org/cargo/guide/)
    * [Clippy Documentation](https://doc.rust-lang.org/nightly/clippy)
```

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

### Rust Documentation Resources

Source: https://docs.rs/ass-editor/0.1.1/src/ass_editor/core/fluent

Provides links to essential Rust programming resources, including the official Rust website, The Book, Standard Library API Reference, Rust by Example, The Cargo Guide, and Clippy Documentation.

```rust
Rust Resources:
- Rust website: https://www.rust-lang.org/
- The Book: https://doc.rust-lang.org/book/
- Standard Library API Reference: https://doc.rust-lang.org/std/
- Rust by Example: https://doc.rust-lang.org/rust-by-example/
- The Cargo Guide: https://doc.rust-lang.org/cargo/guide/
- Clippy Documentation: https://doc.rust-lang.org/nightly/clippy
```

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

### Rust Ecosystem Links

Source: https://docs.rs/ass-editor/0.1.1/src/ass_editor/commands/event_commands

Provides links to essential Rust resources, including the official Rust website, The Book, Standard Library API Reference, Rust by Example, the Cargo Guide, and Clippy documentation. These resources are valuable for learning and using Rust effectively.

```rust
Rust Resources:
- Rust website: https://www.rust-lang.org/
- The Book: https://doc.rust-lang.org/book/
- Standard Library API Reference: https://doc.rust-lang.org/std/
- Rust by Example: https://doc.rust-lang.org/rust-by-example/
- The Cargo Guide: https://doc.rust-lang.org/cargo/guide/
- Clippy Documentation: https://doc.rust-lang.org/nightly/clippy
```

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

### Rust Ecosystem Resources

Source: https://docs.rs/ass-editor/0.1.1/src/ass_editor/formats/mod

Provides links to essential Rust resources, including the official Rust website, The Book, Standard Library API Reference, Rust by Example, the Cargo Guide, and Clippy documentation.

```Rust
Rust website: https://www.rust-lang.org/
The Book: https://doc.rust-lang.org/book/
Standard Library API Reference: https://doc.rust-lang.org/std/
Rust by Example: https://doc.rust-lang.org/rust-by-example/
The Cargo Guide: https://doc.rust-lang.org/cargo/guide/
Clippy Documentation: https://doc.rust-lang.org/nightly/clippy
```

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

### Rust Ecosystem Links

Source: https://docs.rs/ass-editor/0.1.1/src/ass_editor/core/document

Provides links to essential Rust resources, including the official Rust website, The Book, Standard Library API Reference, Rust by Example, the Cargo Guide, and Clippy documentation.

```rust
Rust Resources:
- Rust Website: https://www.rust-lang.org/
- The Book: https://doc.rust-lang.org/book/
- Standard Library API Reference: https://doc.rust-lang.org/std/
- Rust by Example: https://doc.rust-lang.org/rust-by-example/
- Cargo Guide: https://doc.rust-lang.org/cargo/guide/
- Clippy Documentation: https://doc.rust-lang.org/nightly/clippy
```

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

### Rust Ecosystem Links

Source: https://docs.rs/ass-editor/0.1.1/ass_editor/utils/index

Provides links to essential Rust resources, including the official Rust website, The Book, Standard Library API Reference, Rust by Example, The Cargo Guide, and Clippy Documentation.

```rust
Rust Resources:
- Rust website: https://www.rust-lang.org/
- The Book: https://doc.rust-lang.org/book/
- Standard Library API Reference: https://doc.rust-lang.org/std/
- Rust by Example: https://doc.rust-lang.org/rust-by-example/
- The Cargo Guide: https://doc.rust-lang.org/cargo/guide/
- Clippy Documentation: https://doc.rust-lang.org/nightly/clippy
```

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

### Rust Ecosystem Links

Source: https://docs.rs/ass-editor/0.1.1/src/ass_editor/core/position

Provides links to essential Rust resources, including the official Rust website, The Book, Standard Library API Reference, Rust by Example, The Cargo Guide, and Clippy Documentation.

```Rust
Rust:
  * Rust website: https://www.rust-lang.org/
  * The Book: https://doc.rust-lang.org/book/
  * Standard Library API Reference: https://doc.rust-lang.org/std/
  * Rust by Example: https://doc.rust-lang.org/rust-by-example/
  * The Cargo Guide: https://doc.rust-lang.org/cargo/guide/
  * Clippy Documentation: https://doc.rust-lang.org/nightly/clippy
```

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

### Rust Documentation Resources

Source: https://docs.rs/ass-editor/0.1.1/src/ass_editor/core/mod

Provides links to essential Rust programming resources, including the official Rust website, The Book, Standard Library API Reference, Rust by Example, the Cargo Guide, and Clippy documentation.

```Rust
* [Rust website](https://www.rust-lang.org/)
    * [The Book](https://doc.rust-lang.org/book/)
    * [Standard Library API Reference](https://doc.rust-lang.org/std/)
    * [Rust by Example](https://doc.rust-lang.org/rust-by-example/)
    * [The Cargo Guide](https://doc.rust-lang.org/cargo/guide/)
    * [Clippy Documentation](https://doc.rust-lang.org/nightly/clippy)
```

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

### Rust Documentation Resources

Source: https://docs.rs/ass-editor/0.1.1/src/ass_editor/core/builders

Provides links to essential Rust programming language documentation, including the official website, The Book, standard library API reference, Rust by Example, the Cargo Guide, and Clippy documentation.

```rust
// Rust Official Website: https://www.rust-lang.org/
// The Rust Programming Language Book: https://doc.rust-lang.org/book/
// Rust Standard Library API Reference: https://doc.rust-lang.org/std/
// Rust by Example: https://doc.rust-lang.org/rust-by-example/
// The Cargo Guide: https://doc.rust-lang.org/cargo/guide/
// Clippy Documentation: https://doc.rust-lang.org/nightly/clippy
```

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

### Rust Documentation Resources

Source: https://docs.rs/ass-editor/0.1.1/src/ass_editor/extensions/builtin/mod

Provides links to essential Rust programming resources. This includes the official Rust website, The Book, Standard Library API Reference, Rust by Example, the Cargo Guide, and Clippy documentation.

```Rust
Rust Resources:
  Website: https://www.rust-lang.org/
  The Book: https://doc.rust-lang.org/book/
  Standard Library API Reference: https://doc.rust-lang.org/std/
  Rust by Example: https://doc.rust-lang.org/rust-by-example/
  Cargo Guide: https://doc.rust-lang.org/cargo/guide/
  Clippy Documentation: https://doc.rust-lang.org/nightly/clippy
```

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

### Rust Ecosystem Links

Source: https://docs.rs/ass-editor/0.1.1/ass_editor/core/position/index

Provides links to essential Rust resources, including the official Rust website, The Book, Standard Library API Reference, Rust by Example, the Cargo Guide, and Clippy documentation. These are valuable for learning and using Rust effectively.

```Rust
Rust Resources:
- Rust website: https://www.rust-lang.org/
- The Book: https://doc.rust-lang.org/book/
- Standard Library API Reference: https://doc.rust-lang.org/std/
- Rust by Example: https://doc.rust-lang.org/rust-by-example/
- The Cargo Guide: https://doc.rust-lang.org/cargo/guide/
- Clippy Documentation: https://doc.rust-lang.org/nightly/clippy
```

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

### Rust Standard Library and Tools

Source: https://docs.rs/ass-editor/0.1.1/src/ass_editor/core/history

Provides links to essential Rust resources, including the official Rust website, The Book, the Standard Library API Reference, Rust by Example, the Cargo Guide, and Clippy documentation.

```rust
Rust Resources:
  Website: https://www.rust-lang.org/
  The Book: https://doc.rust-lang.org/book/
  Standard Library API Reference: https://doc.rust-lang.org/std/
  Rust by Example: https://doc.rust-lang.org/rust-by-example/
  Cargo Guide: https://doc.rust-lang.org/cargo/guide/
  Clippy Documentation: https://doc.rust-lang.org/nightly/clippy
```

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

### Rust Documentation Resources

Source: https://docs.rs/ass-editor/0.1.1/src/ass_editor/core/thread_safety

Provides links to essential Rust programming resources, including the official Rust website, The Book, Standard Library API Reference, Rust by Example, the Cargo Guide, and Clippy documentation.

```rust
Rust Resources:
  Rust Website: https://www.rust-lang.org/
  The Book: https://doc.rust-lang.org/book/
  Standard Library API Reference: https://doc.rust-lang.org/std/
  Rust by Example: https://doc.rust-lang.org/rust-by-example/
  Cargo Guide: https://doc.rust-lang.org/cargo/guide/
  Clippy Documentation: https://doc.rust-lang.org/nightly/clippy
```

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

### Initialize EditorSessionManager

Source: https://docs.rs/ass-editor/0.1.1/src/ass_editor/sessions/mod

Demonstrates the basic initialization of the EditorSessionManager, which is the starting point for managing ASS editor sessions.

```rust
        let mut manager = EditorSessionManager::new();
```

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

### Replace Tag Command Example

Source: https://docs.rs/ass-editor/0.1.1/src/ass_editor/commands/tag_commands

Demonstrates the functionality of replacing tags within an ASS document. This example shows a basic setup for a replace tag operation.

```rust
let mut doc = EditorDocument::from_content("Hello {\\b1}World{\\b1} Test").unwrap();
```

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

### SyntaxHighlightExtension Creation

Source: https://docs.rs/ass-editor/0.1.1/src/ass_editor/extensions/builtin/syntax_highlight

Demonstrates how to create a new instance of the SyntaxHighlightExtension. This includes setting up extension metadata such as name, version, author, description, capabilities, and license.

```rust
impl SyntaxHighlightExtension {
    /// Create a new syntax highlighting extension
    pub fn new() -> Self {
        let info = ExtensionInfo::new(
            "syntax-highlight".to_string(),
            "1.0.0".to_string(),
            "ASS-RS Team".to_string(),
            "Built-in syntax highlighting for ASS/SSA files".to_string(),
        )
        .with_capability(ExtensionCapability::SyntaxHighlighting)
        .with_license("MIT".to_string());

        Self {
            info,
            state: ExtensionState::Uninitialized,
            token_cache: HashMap::new(),
        }
    }
}
```

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

### Range Struct Documentation

Source: https://docs.rs/ass-editor/0.1.1/src/ass_editor/core/position

Describes the `Range` struct, which represents a half-open interval [start, end) in a document. This convention is common in text editors, where the start is inclusive and the end is exclusive. Includes an example of creating a range.

```rust
/// A range in a document represented by start and end positions
///
/// Ranges are half-open intervals [start, end) where start is inclusive
/// and end is exclusive. This matches standard text editor conventions.
///
/// # Examples
///
/// ```
/// use ass_editor::{Position, Range, EditorDocument};
///
/// let doc = EditorDocument::from_content("Hello World").unwrap();
/// let range = Range::new(Position::new(0), Position::new(5)); // "Hello"
///
/// // Basic properties
/// ```
```

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

### ASS Editor Library Entry Point

Source: https://docs.rs/ass-editor/0.1.1/src/ass_editor/extensions/registry_integration

The main library file for the ass-editor crate.

```rust
pub mod commands;
pub mod core;
pub mod events;
pub mod extensions;
pub mod formats;
pub mod sessions;
pub mod utils;

pub use lib_rs::lib;
```

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

### ASS Editor Library Entry Point

Source: https://docs.rs/ass-editor/0.1.1/src/ass_editor/commands/delta_commands

The main library file for the ass-editor crate.

```rust
pub mod commands;
pub mod core;
pub mod events;
pub mod extensions;
pub mod formats;
pub mod sessions;
pub mod utils;

pub use lib_rs::lib;
```

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

### SrtFormat::new() Constructor

Source: https://docs.rs/ass-editor/0.1.1/ass_editor/formats/srt/struct

Provides a constructor function to create a new instance of the SrtFormat handler. This is the primary way to get started with SRT format processing.

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

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

### ASS Editor Library Entry Point

Source: https://docs.rs/ass-editor/0.1.1/src/ass_editor/commands/macros

The main library file for the ass-editor crate.

```rust
pub mod commands;
pub mod core;
pub mod events;
pub mod extensions;
pub mod formats;
pub mod sessions;
pub mod utils;

pub use lib_rs::lib;
```

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

### ASS Editor Library Entry Point

Source: https://docs.rs/ass-editor/0.1.1/src/ass_editor/commands/event_commands

The main library file for the ass-editor crate.

```rust
pub mod commands;
pub mod core;
pub mod events;
pub mod extensions;
pub mod formats;
pub mod sessions;
pub mod utils;

pub use lib_rs::lib;
```

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

### Related Rust Documentation Resources

Source: https://docs.rs/ass-editor/0.1.1/src/ass_editor/events/mod

Provides links to essential Rust documentation resources, including the official Rust website, The Book, Standard Library API Reference, Rust by Example, and the Cargo Guide.

```Rust
Rust Resources:
- Rust Website: https://www.rust-lang.org/
- The Book: https://doc.rust-lang.org/book/
- Standard Library API Reference: https://doc.rust-lang.org/std/
- Rust by Example: https://doc.rust-lang.org/rust-by-example/
- Cargo Guide: https://doc.rust-lang.org/cargo/guide/
- Clippy Documentation: https://doc.rust-lang.org/nightly/clippy
```

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

### Create and Verify Extension Info

Source: https://docs.rs/ass-editor/0.1.1/src/ass_editor/extensions/mod

Demonstrates how to create an extension with various properties like capabilities, dependencies, homepage, and license, and then verifies these properties using assertions. This snippet showcases the builder pattern for extension configuration.

```rust
let info = ExtensionInfo::builder("test-extension".to_string(), "1.0.0".to_string())
            .with_description("A test extension".to_string())
            .with_capability(ExtensionCapability::TextProcessing)
            .with_dependency("core-extension".to_string())
            .with_homepage("https://example.com".to_string())
            .with_license("MIT".to_string());

        assert_eq!(info.name, "test-extension");
        assert_eq!(info.version, "1.0.0");
        assert!(info.has_capability(&ExtensionCapability::TextProcessing));
        assert_eq!(info.dependencies.len(), 1);
        assert_eq!(info.homepage, Some("https://example.com".to_string()));
        assert_eq!(info.license, Some("MIT".to_string()));
```

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

### ASS Editor Library Entry Point

Source: https://docs.rs/ass-editor/0.1.1/src/ass_editor/core/fluent

The main library file for the ass-editor crate.

```rust
pub mod commands;
pub mod core;
pub mod events;
pub mod extensions;
pub mod formats;
pub mod sessions;
pub mod utils;

pub use lib_rs::lib;
```

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

### ASS Editor Library Entry Point

Source: https://docs.rs/ass-editor/0.1.1/src/ass_editor/utils/indexing

The main library file for the ass-editor crate.

```rust
pub mod commands;
pub mod core;
pub mod events;
pub mod extensions;
pub mod formats;
pub mod sessions;
pub mod utils;

pub use lib_rs::lib;
```

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

### ass-editor Crate Overview

Source: https://docs.rs/ass-editor/0.1.1/src/ass_editor/commands/delta_commands

Provides an overview of the ass-editor crate, including its version, license, source code links, and dependencies. It also indicates the documentation coverage percentage.

```rust
Crate: ass-editor
Version: 0.1.1
License: MIT
Description: High-performance, ergonomic editor layer for ASS subtitles
Dependencies:
- ass-core ^0.1.1
- bumpalo ^3.14 (optional)
- fst ^0.4.7 (optional)
- futures ^0.3 (optional)
- hashbrown ^0.14 (optional)
- parking_lot ^0.12 (optional)
- regex ^1.10 (optional)
- ropey ^1.6.1 (optional)
- serde ^1.0 (optional)
- static_assertions ^1.1 (optional)
- thiserror ^1.0.63 (optional)
- tokio ^1.35 (optional)
- getrandom ^0.2
Dev Dependencies:
- criterion ^0.5
- pretty_assertions ^1.4
- proptest ^1.4
- tempfile ^3.8
Documentation Coverage: 90.95%
```

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

### ASS Editor Library Entry Point

Source: https://docs.rs/ass-editor/0.1.1/src/ass_editor/utils/search

The main library file for the ass-editor crate.

```rust
pub mod commands;
pub mod core;
pub mod events;
pub mod extensions;
pub mod formats;
pub mod sessions;
pub mod utils;

pub use lib_rs::lib;
```

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

### ASS Editor Library Entry Point

Source: https://docs.rs/ass-editor/0.1.1/src/ass_editor/sessions/mod

The main library file for the ass-editor crate.

```rust
pub mod commands;
pub mod core;
pub mod events;
pub mod extensions;
pub mod formats;
pub mod sessions;
pub mod utils;

pub use lib_rs::lib;
```

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

### ASS Editor Library Entry Point

Source: https://docs.rs/ass-editor/0.1.1/src/ass_editor/formats/ass/mod

The main library file for the ass-editor crate.

```rust
pub mod commands;
pub mod core;
pub mod events;
pub mod extensions;
pub mod formats;
pub mod sessions;
pub mod utils;

pub use lib_rs::lib;
```

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

### ASS Editor Library Entry Point

Source: https://docs.rs/ass-editor/0.1.1/src/ass_editor/extensions/mod

The main library file for the ass-editor crate.

```rust
pub mod commands;
pub mod core;
pub mod events;
pub mod extensions;
pub mod formats;
pub mod sessions;
pub mod utils;

pub use lib_rs::lib;
```

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

### Navigate to a specific line

Source: https://docs.rs/ass-editor/0.1.1/src/ass_editor/core/fluent

The `at_line` function allows you to get a fluent operation starting at a specific line number in the document. It handles invalid line numbers by returning an error. This function requires the `rope` feature to be enabled.

```rust
pub fn at_line(&mut self, line: usize) -> Result<AtPosition<'_>> {
    let line_idx = line.saturating_sub(1);
    if line_idx >= self.rope().len_lines() {
        return Err(EditorError::InvalidPosition { line, column: 1 });
    }
    let byte_pos = self.rope().line_to_byte(line_idx);
    Ok(AtPosition::new(self, Position::new(byte_pos)))
}
```

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

### ASS Editor Library Entry Point

Source: https://docs.rs/ass-editor/0.1.1/src/ass_editor/core/builders

The main library file for the ass-editor crate.

```rust
pub mod commands;
pub mod core;
pub mod events;
pub mod extensions;
pub mod formats;
pub mod sessions;
pub mod utils;

pub use lib_rs::lib;
```

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

### ASS Editor Library Entry Point

Source: https://docs.rs/ass-editor/0.1.1/src/ass_editor/formats/srt/mod

The main library file for the ass-editor crate.

```rust
pub mod commands;
pub mod core;
pub mod events;
pub mod extensions;
pub mod formats;
pub mod sessions;
pub mod utils;

pub use lib_rs::lib;
```

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

### ASS Editor Library Entry Point

Source: https://docs.rs/ass-editor/0.1.1/src/ass_editor/core/document

The main library file for the ass-editor crate.

```rust
pub mod commands;
pub mod core;
pub mod events;
pub mod extensions;
pub mod formats;
pub mod sessions;
pub mod utils;

pub use lib_rs::lib;
```

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

### Get Tag Completions (Rust)

Source: https://docs.rs/ass-editor/0.1.1/src/ass_editor/extensions/builtin/auto_complete

Generates a list of tag completion items based on a provided prefix. It filters a list of tags, matching them against the prefix (case-insensitive for non-empty prefixes) and creates `CompletionItem` objects with associated descriptions and examples. The function handles empty prefixes by including all tags.

```rust
fn get_tag_completions(&self, prefix: &str, tags: Vec<(&str, &str, &str)>) -> Vec<CompletionItem> {
        tags.into_iter()
            .filter(|(name, _, _)| {
                if prefix.is_empty() {
                    true
                } else {
                    name[1..].starts_with(prefix)
                }
            })
            .enumerate()
            .map(|(i, (name, desc, example))| {
                CompletionItem::new(example.to_string(), name.to_string(), CompletionType::Tag)
                    .with_description(desc.to_string())
                    .with_detail(example.to_string())
                    .with_sort_order(i as u32)
            })
            .collect()
    }
```

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

### Test Timing Adjust with Specific Events in Rust

Source: https://docs.rs/ass-editor/0.1.1/src/ass_editor/commands/event_commands

This Rust test case focuses on the `TimingAdjustCommand`'s functionality when applied to specific events within a document. The example shows initializing an `EditorDocument` and then preparing to adjust the timing of the first event. This setup is for testing targeted timing modifications.

```rust
let mut doc = EditorDocument::from_content(TEST_CONTENT).unwrap();
// Adjust only first event
```

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

### ASS Editor Library Entry Point

Source: https://docs.rs/ass-editor/0.1.1/src/ass_editor/extensions/builtin/auto_complete

The main library file for the ass-editor crate.

```rust
pub mod commands;
pub mod core;
pub mod events;
pub mod extensions;
pub mod formats;
pub mod sessions;
pub mod utils;

pub use lib_rs::lib;
```

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

### Get Supported Export Extensions

Source: https://docs.rs/ass-editor/0.1.1/src/ass_editor/formats/mod

Retrieves the list of supported file extensions for exporting ASS (Advanced SubStation Alpha) subtitles. This function is part of the format registry and is used to determine which file types the editor can export to. The example also includes assertions to verify that initially, no import or export extensions are supported, which is typical for an uninitialized or default state.

```rust
let export_exts = registry.supported_export_extensions();

assert!(import_exts.is_empty());
assert!(export_exts.is_empty());
```

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

### ASS Editor Library Entry Point

Source: https://docs.rs/ass-editor/0.1.1/src/ass_editor/core/mod

The main library file for the ass-editor crate.

```rust
pub mod commands;
pub mod core;
pub mod events;
pub mod extensions;
pub mod formats;
pub mod sessions;
pub mod utils;

pub use lib_rs::lib;
```

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

### Initialize Extension Manager

Source: https://docs.rs/ass-editor/0.1.1/src/ass_editor/extensions/mod

Demonstrates the creation of a new ExtensionManager and verifies that it is initialized with no extensions or commands.

```rust
let manager = ExtensionManager::new();
        assert_eq!(manager.list_extensions().len(), 0);
        assert_eq!(manager.list_commands().len(), 0);
```

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

### Shift Start Times of Events

Source: https://docs.rs/ass-editor/0.1.1/src/ass_editor/commands/event_commands

Creates a `TimingAdjustCommand` to adjust only the start times of specified events. The duration of each event remains constant as only the start time is shifted.

```rust
pub fn shift_start(event_indices: Vec<usize>, offset_cs: i32) -> Self {
    Self::new(event_indices, offset_cs, offset_cs)
}
```

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

### Shift Specific Event Start Time

Source: https://docs.rs/ass-editor/0.1.1/src/ass_editor/core/fluent

Illustrates how to shift the start time of a specific event within an EditorDocument. This operation targets a single event by its index and modifies only its start timing.

```rust
let mut doc = EditorDocument::from_content(TEST_CONTENT).unwrap();

// Test adjusting only first event
doc.events()
    .timing()
    .event(0)
    .shift_start(100) // +1 second to start only
    .unwrap();

// Only first event should change
assert!(doc.text().contains("0:00:02.00,0:00:05.00")); // First event start shifted
assert!(doc.text().contains("0:00:05.00,0:00:10.00")); // Second event unchanged
```

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

### ASS Editor Library Entry Point

Source: https://docs.rs/ass-editor/0.1.1/src/ass_editor/core/errors

The main library file for the ass-editor crate.

```rust
pub mod commands;
pub mod core;
pub mod events;
pub mod extensions;
pub mod formats;
pub mod sessions;
pub mod utils;

pub use lib_rs::lib;
```

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

### Display Range Information

Source: https://docs.rs/ass-editor/0.1.1/src/ass_editor/core/position

Implements the `Display` trait for the `Range` struct, providing a human-readable string representation. If the range is empty (start equals end), it displays only the start position. Otherwise, it displays the start and end positions separated by a hyphen.

```rust
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        if self.is_empty() {
            write!(f, "{}", self.start)
        } else {
            write!(f, "{}-{}", self.start, self.end)
        }
    }
```

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

### ASS Editor Library Entry Point

Source: https://docs.rs/ass-editor/0.1.1/src/ass_editor/extensions/builtin/syntax_highlight

The lib.rs file serves as the main entry point for the ass-editor Rust crate, likely exporting public APIs and defining the crate's overall structure.

```rust
lib.rs
```

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

### ASS Editor Library Entry Point

Source: https://docs.rs/ass-editor/0.1.1/src/ass_editor/events/mod

The main library file for the ass-editor crate.

```rust
pub mod commands;
pub mod core;
pub mod events;
pub mod extensions;
pub mod formats;
pub mod sessions;
pub mod utils;

pub use lib_rs::lib;
```

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

### Find Section End by Start Position

Source: https://docs.rs/ass-editor/0.1.1/src/ass_editor/core/document

Determines the ending byte index of a section in the ASS content, given the starting index of its header. It searches for the next known section header after the provided start position to define the end of the current section. This function requires the `stream` feature.

```rust
fn find_section_end_from_start(&self, content: &str, start: usize) -> Result<usize>
    let section_headers = [
        "[Script Info]",
        "[V4+ Styles]",
        "[Events]",
        "[Fonts]",
        "[Graphics]",
    ];
    let mut end = content.len();
    for header in &section_headers {
        if let Some(pos) = content[start + 1..].find(header) {
            let actual_pos = start + 1 + pos;
            if actual_pos < end {
                end = actual_pos;
            }
        }
    }
    Ok(end)

```

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

### EventChannel Configuration Example

Source: https://docs.rs/ass-editor/0.1.1/src/ass_editor/events/mod

An example of how to configure an EventChannel with specific parameters like max handlers, queue size, and batching options.

```rust
Self {
    max_handlers: 100,
    max_async_queue_size: 1000,
    enable_batching: false,
    max_batch_size: 10,
    enable_logging: false,
}
```

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

### ASS Editor Library Entry Point

Source: https://docs.rs/ass-editor/0.1.1/src/ass_editor/core/history

The main library file for the ass-editor crate.

```rust
pub mod commands;
pub mod core;
pub mod events;
pub mod extensions;
pub mod formats;
pub mod sessions;
pub mod utils;

pub use lib_rs::lib;
```

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

### Feature Flags: Cargo.toml Examples

Source: https://docs.rs/ass-editor/0.1.1/index

Provides examples of how to specify ass-editor dependencies in Cargo.toml to enable or disable specific features like 'minimal', 'simd', or 'nostd'.

```toml
# Full-featured desktop editor (default)
ass-editor = "0.1"

# Minimal editor for lightweight integrations
ass-editor = { version = "0.1", default-features = false, features = ["minimal"] }

# Maximum performance with SIMD
ass-editor = { version = "0.1", features = ["full", "simd"] }

# WASM/embedded build
ass-editor = { version = "0.1", default-features = false, features = ["minimal", "nostd"] }
```

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

### Feature Flags: Cargo.toml Examples

Source: https://docs.rs/ass-editor/0.1.1/ass_editor

Provides examples of how to specify ass-editor dependencies in Cargo.toml to enable or disable specific features like 'minimal', 'simd', or 'nostd'.

```toml
# Full-featured desktop editor (default)
ass-editor = "0.1"

# Minimal editor for lightweight integrations
ass-editor = { version = "0.1", default-features = false, features = ["minimal"] }

# Maximum performance with SIMD
ass-editor = { version = "0.1", features = ["full", "simd"] }

# WASM/embedded build
ass-editor = { version = "0.1", default-features = false, features = ["minimal", "nostd"] }
```

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

### Syntax Highlighting Initialization and Configuration

Source: https://docs.rs/ass-editor/0.1.1/src/ass_editor/extensions/builtin/syntax_highlight

Handles the initialization of syntax highlighting, including setting configuration options for error highlighting and maximum tokens. It also displays an informational message upon successful initialization.

```rust
fn initialize(&mut self, context: &mut dyn ExtensionContext) -> Result<()>
    // ...
    if let Some(errors) = context.get_config("syntax.highlight_errors") {
        self.config.highlight_errors = errors == "true";
    }
    if let Some(max_tokens) = context.get_config("syntax.max_tokens") {
        if let Ok(max) = max_tokens.parse() {
            self.config.max_tokens = max;
        }
    }
    context.show_message("Syntax highlighting initialized", MessageLevel::Info)?;
    Ok(())
}
```

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

### Execute Query and Get Event Count

Source: https://docs.rs/ass-editor/0.1.1/src/ass_editor/core/fluent

Executes the query and returns the total number of matching events. This is achieved by getting the length of the vector returned by `execute()`.

```rust
pub fn count(self) -> Result<usize> {
        Ok(self.execute()?.len())
    }
```

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

### Start Fluent Operation at Position

Source: https://docs.rs/ass-editor/0.1.1/src/ass_editor/core/fluent

Initializes a fluent editing operation starting at a specific position within the ASS document. This is the entry point for many fluent API calls.

```rust
pub fn at_pos(&mut self, position: Position) -> AtPosition<'_> {
    AtPosition::new(self, position)
}
```

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

### Edit ASS Style

Source: https://docs.rs/ass-editor/0.1.1/src/ass_editor/commands/style_commands

Illustrates how to modify an existing ASS style. This example shows the initialization of an `EditStyleCommand` for a style named 'Default'. Further details on the specific edits would follow in a complete example.

```rust
use crate::core::EditorDocument;
use ass_editor::commands::style_commands::EditStyleCommand;

// ... inside a test function ...
let mut doc = EditorDocument::from_content(TEST_CONTENT).unwrap();

let command = EditStyleCommand::new("Default".to_string());
// Further modifications to the command would be applied here before execution.
```

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

### Find Section Start by Header

Source: https://docs.rs/ass-editor/0.1.1/src/ass_editor/core/document

Locates the starting byte index of a section within the ASS content string, identified by its header. If the header is not found, it returns an error. This function is conditional on the `stream` feature.

```rust
fn find_section_start_by_header(&self, content: &str, header: &str) -> Result<usize>
    content
        .find(header)
        .ok_or_else(|| EditorError::SectionNotFound {
            section: header.to_string(),
        })

```

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

### ass-editor Crate Information

Source: https://docs.rs/ass-editor/0.1.1/ass_editor/commands/style_commands/index

Provides an overview of the ass-editor Rust crate, including its version, license, source code repository, and links to its documentation on docs.rs and crates.io. It also lists the crate's dependencies and their versions.

```rust
Crate: ass-editor
Version: 0.1.1
License: MIT
Repository: https://github.com/wiedymi/ass-rs
Documentation: https://docs.rs/ass-editor/0.1.1/ass_editor/
Crates.io: https://crates.io/crates/ass-editor

Dependencies:
- ass-core ^0.1.1
- bumpalo ^3.14 (optional)
- fst ^0.4.7 (optional)
- futures ^0.3 (optional)
- hashbrown ^0.14 (optional)
- parking_lot ^0.12 (optional)
- regex ^1.10 (optional)
- ropey ^1.6.1 (optional)
- serde ^1.0 (optional)
- static_assertions ^1.1 (optional)
- thiserror ^1.0.63 (optional)
- tokio ^1.35 (optional)
- getrandom ^0.2

Dev Dependencies:
- criterion ^0.5
- pretty_assertions ^1.4
- proptest ^1.4
- tempfile ^3.8

Documentation Coverage: 90.95%
```

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

### Range Struct and Initialization

Source: https://docs.rs/ass-editor/0.1.1/src/ass_editor/core/position

Defines the `Range` struct with `start` and `end` positions, and provides methods for creating new ranges, ensuring normalization (start <= end), and creating empty ranges at a given position.

```rust
/// assert_eq!(range.len(), 5);
/// assert!(!range.is_empty());
/// assert!(range.contains(Position::new(2)));
/// assert!(!range.contains(Position::new(5))); // End is exclusive
///
/// // Range operations
/// let other = Range::new(Position::new(3), Position::new(8)); // "lo Wo"
/// assert!(range.overlaps(&other));
///
/// let union = range.union(&other);
/// assert_eq!(union.start.offset, 0);
/// assert_eq!(union.end.offset, 8);
/// ```
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub struct Range {
    /// Start position (inclusive)
    pub start: Position,
    /// End position (exclusive)
    pub end: Position,
}

impl Range {
    /// Create a new range
    ///
    /// Automatically normalizes so start <= end
    #[must_use]
    pub fn new(start: Position, end: Position) -> Self {
        if start.offset <= end.offset {
            Self { start, end }
        } else {
            Self {
                start: end,
                end: start,
            }
        }
    }

    /// Create an empty range at position
    #[must_use]
    pub const fn empty(pos: Position) -> Self {
        Self {
            start: pos,
            end: pos,
        }
    }

    /// Check if range is empty (start == end)

```

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

### Test Selection Direction

Source: https://docs.rs/ass-editor/0.1.1/src/ass_editor/core/position

Tests the functionality of the Selection struct to determine if it's reversed and to access its start and end positions. It creates a selection with a start position greater than the end position and asserts the expected behavior.

```rust
    #[test]
    fn selection_direction() {
        let sel = Selection::new(Position::new(10), Position::new(5));
        assert!(sel.is_reversed());
        assert_eq!(sel.range().start.offset, 5);
        assert_eq!(sel.range().end.offset, 10);
    }
```

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

### ASS Editor Library Entry Point

Source: https://docs.rs/ass-editor/0.1.1/src/ass_editor/formats/webvtt/mod

The lib.rs file serves as the main entry point for the ass-editor Rust crate, likely exporting public APIs and defining the crate's overall structure.

```rust
lib.rs
```

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

### Start fluent operations

Source: https://docs.rs/ass-editor/0.1.1/src/ass_editor/core/fluent

Provides methods to initiate fluent operations for various aspects of ASS subtitle editing. These include navigating to the start or end of the document, selecting a range, and operating on styles, events, tags, and karaoke.

```rust
/// Start a fluent operation at the start of the document
pub fn at_start(&mut self) -> AtPosition<'_> {
    AtPosition::new(self, Position::start())
}
```

```rust
/// Start a fluent operation at the end of the document
pub fn at_end(&mut self) -> AtPosition<'_> {
    let end_pos = Position::new(self.len());
    AtPosition::new(self, end_pos)
}
```

```rust
/// Start a fluent operation on a range
pub fn select(&mut self, range: Range) -> SelectRange<'_> {
    SelectRange::new(self, range)
}
```

```rust
/// Start fluent style operations
pub fn styles(&mut self) -> StyleOps<'_> {
    StyleOps::new(self)
}
```

```rust
/// Start fluent event operations
pub fn events(&mut self) -> EventOps<'_> {
    EventOps::new(self)
}
```

```rust
/// Start fluent tag operations
pub fn tags(&mut self) -> TagOps<'_> {
    TagOps::new(self)
}
```

```rust
/// Start fluent karaoke operations
pub fn karaoke(&mut self) -> KaraokeOps<'_> {
    KaraokeOps::new(self)
}
```

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

### ass-editor Crate Overview

Source: https://docs.rs/ass-editor/0.1.1/ass_editor/utils/formats/fn

Provides an overview of the ass-editor crate, its version, license, source code repository, and dependencies. It also indicates the documentation coverage percentage.

```Rust
Crate: ass-editor
Version: 0.1.1
License: MIT
Repository: https://github.com/wiedymi/ass-rs
Documentation Coverage: 90.95%
Dependencies:
  - ass-core ^0.1.1
  - bumpalo ^3.14 (optional)
  - fst ^0.4.7 (optional)
  - futures ^0.3 (optional)
  - hashbrown ^0.14 (optional)
  - parking_lot ^0.12 (optional)
  - regex ^1.10 (optional)
  - ropey ^1.6.1 (optional)
  - serde ^1.0 (optional)
  - static_assertions ^1.1 (optional)
  - thiserror ^1.0.63 (optional)
  - tokio ^1.35 (optional)
  - getrandom ^0.2
Dev Dependencies:
  - criterion ^0.5
  - pretty_assertions ^1.4
  - proptest ^1.4
  - tempfile ^3.8
```

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

### EventTimer: Shift Timings

Source: https://docs.rs/ass-editor/0.1.1/src/ass_editor/core/fluent

Allows shifting the start and end times of selected events. The `shift` method preserves duration by applying the same offset to both start and end times. `shift_start` and `shift_end` modify duration by only shifting one of the times.

```rust
impl<'a> EventTimer<'a> {
    /// Shift start and end times by the same offset (preserves duration)
    pub fn shift(self, offset_cs: i32) -> Result<&'a mut EditorDocument> {
        let command = TimingAdjustCommand::new(self.event_indices, offset_cs, offset_cs);
        command.execute(self.document)?;
        Ok(self.document)
    }

    /// Shift only start times (changes duration)
    pub fn shift_start(self, offset_cs: i32) -> Result<&'a mut EditorDocument> {
        let command = TimingAdjustCommand::new(self.event_indices, offset_cs, 0);
        command.execute(self.document)?;
        Ok(self.document)
    }

    /// Shift only end times (changes duration)
    pub fn shift_end(self, offset_cs: i32) -> Result<&'a mut EditorDocument> {
        let command = TimingAdjustCommand::new(self.event_indices, 0, offset_cs);
        command.execute(self.document)?;
        Ok(self.document)
    }
}
```

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

### ASS Editor Library Entry Point

Source: https://docs.rs/ass-editor/0.1.1/src/ass_editor/utils/validator

The main library file for the ass-editor crate.

```rust
pub mod commands;
pub mod core;
pub mod events;
pub mod extensions;
pub mod formats;
pub mod sessions;
pub mod utils;

pub use lib_rs::lib;
```

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

### Indent Lines in ass-editor

Source: https://docs.rs/ass-editor/0.1.1/src/ass_editor/core/fluent

This Rust function indents a range of lines in the document by adding a specified number of spaces to the beginning of each line. It calculates line start positions and then replaces the empty range at the start of each line with the indentation string.

```rust
fn indent(self, spaces: usize) -> Result<&'a mut EditorDocument> {
        // Get line information before mutating
        let start_line = self.document.rope().byte_to_line(self.range.start.offset);
        let end_line = self.document.rope().byte_to_line(self.range.end.offset);
        let indent = " ".repeat(spaces);

        // Collect line positions
        let mut line_positions = Vec::new();
        for line_idx in (start_line..=end_line).rev() {
            let line_start = self.document.rope().line_to_byte(line_idx);
            line_positions.push(line_start);
        }

        // Apply indentation
        for line_start in line_positions {
            let pos = Position::new(line_start);
            let range = Range::empty(pos);
            self.document.replace(range, &indent)?;
        }

        Ok(self.document)
    }
```

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

### FST Regex Search Example

Source: https://docs.rs/ass-editor/0.1.1/src/ass_editor/utils/search

Demonstrates using the FST (Finite State Transducer) based regex search. This example initializes a document and performs a search, though the specific pattern and assertions are not fully detailed in the provided snippet.

```rust
use crate::core::EditorDocument;

let doc = EditorDocument::from_content("[Events]\nDialogue: 0,0:00:00.00,0:00:05.00,Default,,0,0,0,,Test dialogue")
.unwrap();
// Further search operations would follow here, utilizing the FST index.
```

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

### Create Extension Command

Source: https://docs.rs/ass-editor/0.1.1/src/ass_editor/extensions/mod

Demonstrates the creation of an ExtensionCommand with a name, display name, and description. This is a basic test for the command creation functionality.

```rust
let command = ExtensionCommand::new(
            "test-command".to_string(),
            "Test Command".to_string(),
            "A test command".to_string(),
        );
```
Tokens:
Raw