Rosu Map

https://docs.rs/rosu-map/latest/
Admin
A Rust library for decoding and encoding `.osu` beatmap files from osu!, providing flexible parsing...
Tokens:437,616
Snippets:2,435
Trust Score:9.7
Update:8 months ago
Show doc for...
Tokens:
Raw
### Get Total Distance of Curve in Rust

Source: https://docs.rs/rosu-map/latest/rosu_map/section/hit_objects/struct.Curve

Returns the total calculated distance of the `Curve` from its start to its end. This is the maximum value that `progress_to_dist` can output.

```rust
pub fn dist(&self) -> f64
```

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

### TryFrom and TryInto Conversions

Source: https://docs.rs/rosu-map/latest/rosu_map/section/general/struct.General_search=

Documentation for the `TryFrom` and `TryInto` traits, which provide fallible conversion methods between types.

```APIDOC
## impl<T, U> TryFrom<U> for T
where U: Into<T>

### Description
Provides a fallible way to convert a type `U` into another type `T`. The conversion can fail, indicated by the `Result` type.

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

### Endpoint
N/A (Trait method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (N/A)
- `try_from`: Attempts to perform the conversion. Returns `Ok(T)` on success or `Err(Error)` on failure.

#### Response Example
None
```

```APIDOC
## impl<T, U> TryInto<U> for T
where U: TryFrom<T>

### Description
Provides a fallible way to convert a type `T` into another type `U`, provided that `U` implements `TryFrom<T>`.

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

### Endpoint
N/A (Trait method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (N/A)
- `try_into`: Attempts to perform the conversion. Returns `Ok(U)` on success or `Err(Error)` on failure.

#### Response Example
None
```

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

### Implement New Combo Check for HitObjectKind in Rust

Source: https://docs.rs/rosu-map/latest/src/rosu_map/section/hit_objects/mod.rs_search=u32+-%3E+bool

Implements a `new_combo` method for `HitObjectKind` to determine if a hit object starts a new combo. Hold objects are explicitly defined as not starting new combos.

```rust
impl HitObjectKind {
    pub const fn new_combo(&self) -> bool {
        match self {
            Self::Circle(h) => h.new_combo,
            Self::Slider(h) => h.new_combo,
            Self::Spinner(h) => h.new_combo,
            Self::Hold(_) => false,
        }
    }
}
```

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

### From and Into Conversions

Source: https://docs.rs/rosu-map/latest/rosu_map/section/general/struct.General_search=

Documentation for the `From` and `Into` traits, which provide standard ways to convert between types.

```APIDOC
## impl<T> From<T> for T

### Description
Provides a way to convert a type `T` into itself. This is a trivial conversion.

### Method
`fn from(t: T) -> T`

### Endpoint
N/A (Trait method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (N/A)
Returns the argument unchanged.

#### Response Example
None
```

```APIDOC
## impl<T, U> Into<U> for T
where U: From<T>

### Description
Provides a way to convert a type `T` into another type `U`, provided that `U` implements `From<T>`.

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

### Endpoint
N/A (Trait method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (N/A)
Calls `U::from(self)`. The conversion behavior is determined by the `From<T> for U` implementation.

#### Response Example
None
```

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

### TryFrom and TryInto Traits

Source: https://docs.rs/rosu-map/latest/rosu_map/section/timing_points/struct.ControlPoints_search=

Documentation for the `TryFrom` and `TryInto` traits, which provide fallible type conversions.

```APIDOC
## `TryFrom` Trait

### Description
Provides a fallible conversion from one type to another. This trait is the reciprocal of `TryInto`.

### Method
`try_from`

### Endpoint
N/A (Trait Implementation)

### Parameters
- **value** (*U*) - Required - The value to attempt to convert.

### Request Example
None

### Response
#### Success Response (N/A)
- **Result<T, <T as TryFrom<U>>::Error>** - A `Result` containing the converted value `T` on success, or an error type on failure.

#### Response Example
None

## `TryInto` Trait

### Description
Provides a fallible conversion from one type to another. This trait is the reciprocal of `TryFrom`.

### Method
`try_into`

### Endpoint
N/A (Trait Implementation)

### Parameters
None (Called on the value itself).

### Request Example
None

### Response
#### Success Response (N/A)
- **Result<U, <U as TryFrom<T>>::Error>** - A `Result` containing the converted value `U` on success, or an error type on failure.

#### Response Example
None
```

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

### Parse Hold Hit Object in Rust

Source: https://docs.rs/rosu-map/latest/src/rosu_map/section/hit_objects/decode.rs_search=std%3A%3Avec

Parses a hold hit object. It determines the end time, which is the maximum of the current start time and a raw start time, potentially updated by a new end time from input. Custom sample banks can also be read.

```rust
let mut end_time = start_time.max(start_time_raw);

if let Some(s) = split.next().filter(|s| !s.is_empty()) {
    let mut ss = s.split(':');

    let new_end_time = ss
        .next()
        .ok_or(ParseHitObjectsError::InvalidLine)?
        .parse_num::<f64>()?;

    end_time = start_time.max(new_end_time);

    bank_info.read_custom_sample_banks(ss, false)?;
}

let hold = HitObjectHold {
    pos_x: pos.x,
    duration: end_time - start_time,
};

HitObjectKind::Hold(hold)
```

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

### Rust: Implementations for Any, Borrow, CloneToUninit, From, Into, ToOwned, TryFrom, TryInto

Source: https://docs.rs/rosu-map/latest/rosu_map/section/timing_points/struct.TimingPoints_search=u32+-%3E+bool

This section details various blanket implementations in Rust for common traits. These implementations provide default or generic functionality for types that satisfy certain trait bounds, simplifying generic programming. Note that `clone_to_uninit` is an unstable, nightly-only feature.

```rust
impl<T> Any for T where T: 'static + ?Sized
fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized
fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized
fn borrow_mut(&mut self) -> &mut T

impl<T> CloneToUninit for T where T: Clone
unsafe fn clone_to_uninit(&self, dest: *mut u8)

impl<T> From<T> for T
fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>
fn into(self) -> U

impl<T> ToOwned for T where T: Clone
type Owned = T
fn to_owned(&self) -> T
fn clone_into(&self, target: &mut T)

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

impl<T, U> TryInto<U> for T where U: TryFrom<T>
type Error = <U as TryFrom<T>>::Error
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
```

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

### Method Signature Example in Rust

Source: https://docs.rs/rosu-map/latest/rosu_map/section/colors/struct.CustomColor_search=u32+-%3E+bool

Provides an example of a method signature: `check_already_existing`. This method is part of the `ControlPoint` struct and takes a reference to `ControlPoint` and a generic parameter `C` as input, returning a boolean value. It checks if the current instance is redundant with an existing one.

```Rust
### 
### Type "u32" not found and used as generic parameter. Consider searching for "i32" instead.
trait method
rosu_map::section::timing_points::ControlPoint::check_already_existing
&ControlPoint, &**C** -> **bool**
where
u32 matches **C**
Whether `self` is redundant w.r.t. an already existing …
```

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

### Define HitObject Structure and Methods (Rust)

Source: https://docs.rs/rosu-map/latest/src/rosu_map/section/hit_objects/mod.rs_search=

Defines the `HitObject` struct which represents a single hit object in a beatmap. It includes fields for start time, kind, and hit samples. Methods are provided to check if a hit object starts a new combo and to calculate its end time, with an option to reuse curve buffers for efficiency.

```rust
/// A hit object of a [`Beatmap`].
///
/// [`Beatmap`]: crate::beatmap::Beatmap
#[derive(Clone, Debug, PartialEq)]
pub struct HitObject {
    pub start_time: f64,
    pub kind: HitObjectKind,
    pub samples: Vec<HitSampleInfo>,
}

impl HitObject {
    /// Whether the [`HitObject`] starts a new combo.
    pub const fn new_combo(&self) -> bool {
        self.kind.new_combo()
    }

    /// Returns the end time of the [`HitObject`].
    ///
    /// If the curve has not yet been accessed, it needs to be calculated
    /// first.
    ///
    /// In case curves of multiple slider paths are being calculated, it is
    /// recommended to initialize [`CurveBuffers`] and pass a mutable reference
    /// of it to [`HitObject::end_time_with_bufs`] so the buffers are re-used
    /// for all sliders.
    pub fn end_time(&mut self) -> f64 {
        self.end_time_with_bufs(&mut CurveBuffers::default())
    }

    /// Returns the end time of the [`HitObject`].
    ///
    /// If the slider's curve has not yet been accessed, it needs to be
    /// calculated first for which the given [`CurveBuffers`] are used.
    pub fn end_time_with_bufs(&mut self, bufs: &mut CurveBuffers) -> f64 {
        match self.kind {
            HitObjectKind::Circle(_) => self.start_time,
            HitObjectKind::Slider(ref mut h) => self.start_time + h.duration_with_bufs(bufs),
            HitObjectKind::Spinner(ref h) => self.start_time + h.duration,
            HitObjectKind::Hold(ref h) => self.start_time + h.duration,
        }
    }
}
```

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

### Implement SampleBankInfo Methods

Source: https://docs.rs/rosu-map/latest/rosu_map/section/hit_objects/hit_samples/struct.SampleBankInfo

Provides implementations for SampleBankInfo, including methods to read custom sample banks from a split string and convert a HitSoundType into a vector of HitSampleInfo. These methods are crucial for processing hit object data.

```rust
pub fn read_custom_sample_banks( &mut self, split: Split<'_, char>, banks_only: bool, ) -> Result<(), ParseSampleBankInfoError>
```

```rust
pub fn convert_sound_type(self, sound_type: HitSoundType) -> Vec<HitSampleInfo>
```

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

### CloneToUninit Trait Implementation (Nightly)

Source: https://docs.rs/rosu-map/latest/rosu_map/section/timing_points/struct.TimingPoints

Nightly-only experimental API for performing copy-assignment to uninitialized memory.

```APIDOC
## impl<T> CloneToUninit for T

### Description
Nightly-only experimental API. Performs copy-assignment from `self` to a mutable pointer `dest`.

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

### Endpoint
N/A

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

### Request Example
None

### Response
#### Success Response (N/A)
None

### Response Example
None
```

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

### Trait Implementation: Error::description

Source: https://docs.rs/rosu-map/latest/rosu_map/section/hit_objects/struct.ParseHitObjectTypeError_search=u32+-%3E+bool

Deprecated method for getting a description of the error.

```APIDOC
## Trait Implementation: Error::description

### Description
👎 **Deprecated since 1.42.0**: use the Display impl or to_string()
Returns a string description of the error.

### Method
`description(&self) -> &str`
```

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

### impl<T> CloneToUninit for T

Source: https://docs.rs/rosu-map/latest/rosu_map/section/timing_points/struct.TimingPoints_search=

Provides an experimental, nightly-only method for unsafe copy-assignment to uninitialized memory.

```APIDOC
## POST /impl/CloneToUninit

### Description
Provides an experimental, nightly-only method for unsafe copy-assignment to uninitialized memory. This API is unstable and may change.

### Method
POST

### Endpoint
/impl/CloneToUninit

### Parameters
#### Query Parameters
- **T** (type) - Required - The type parameter for the implementation.

#### Request Body
- **dest** (*mut u8) - Required - A raw pointer to the destination memory.

### Request Example
{
  "example": "{\"dest\": \"0x12345678\"}"
}

### Response
#### Success Response (200)
Indicates successful copy-assignment. No specific return value is documented for success.

#### Response Example
{
  "example": "{\"status\": \"success\"}"
}
```

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

### Trait Implementation: Error::cause

Source: https://docs.rs/rosu-map/latest/rosu_map/section/hit_objects/struct.ParseHitObjectTypeError_search=u32+-%3E+bool

Deprecated method for getting the lower-level source of an error.

```APIDOC
## Trait Implementation: Error::cause

### Description
👎 **Deprecated since 1.33.0**: replaced by `Error::source`, which can support downcasting
Returns the lower-level source of this error, if any.

### Method
`cause(&self) -> Option<&dyn Error>`
```

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

### Get Difficulty from HitObjectsState in Rust

Source: https://docs.rs/rosu-map/latest/rosu_map/section/hit_objects/struct.HitObjectsState_search=u32+-%3E+bool

Provides a method to access the DifficultyState within a HitObjectsState instance.

```rust
pub const fn difficulty(&self) -> &Difficulty
```

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

### Define and Initialize SamplePoint in Rust

Source: https://docs.rs/rosu-map/latest/src/rosu_map/section/timing_points/control_points/sample.rs_search=std%3A%3Avec

Defines the SamplePoint struct for audio timing information and provides a constructor to create new instances. It also includes default values and methods for checking redundancy and applying sample information.

```rust
use std::{cmp::Ordering, num::NonZeroU32};

use crate::section::hit_objects::hit_samples::{HitSampleInfo, HitSampleInfoName, SampleBank};

#[derive(Clone, Debug, PartialEq)]
/// Audio-related info about this control point.
pub struct SamplePoint {
    pub time: f64,
    pub sample_bank: SampleBank,
    pub sample_volume: i32,
    pub custom_sample_bank: i32,
}

impl SamplePoint {
    pub const DEFAULT_SAMPLE_BANK: SampleBank = SampleBank::Normal;
    pub const DEFAULT_SAMPLE_VOLUME: i32 = 100;
    pub const DEFAULT_CUSTOM_SAMPLE_BANK: i32 = 0;

    pub fn new(
        time: f64,
        sample_bank: SampleBank,
        sample_volume: i32,
        custom_sample_bank: i32,
    ) -> Self {
        Self {
            time,
            sample_bank,
            sample_volume: sample_volume.clamp(0, 100),
            custom_sample_bank,
        }
    }

    pub fn is_redundant(&self, existing: &Self) -> bool {
        self.sample_bank == existing.sample_bank
            && self.sample_volume == existing.sample_volume
            && self.custom_sample_bank == existing.custom_sample_bank
    }

    pub fn apply(&self, sample: &mut HitSampleInfo) {
        if matches!(sample.name, HitSampleInfoName::Default(_)) {
            if sample.custom_sample_bank == 0 {
                sample.custom_sample_bank = self.custom_sample_bank;

                if sample.custom_sample_bank >= 2 {
                    // SAFETY: The value is guaranteed to be >= 2
                    sample.suffix = Some(unsafe {
                        NonZeroU32::new_unchecked(sample.custom_sample_bank as u32)
                    });
                }
            }

            if sample.volume == 0 {
                sample.volume = self.sample_volume.clamp(0, 100);
            }

            if !sample.bank_specified {
                sample.bank = self.sample_bank;
                sample.bank_specified = true;
            }
        } else {
            sample.bank = SamplePoint::DEFAULT_SAMPLE_BANK;
            sample.suffix = None;

            if sample.volume == 0 {
                sample.volume = self.sample_volume.clamp(0, 100);
            }

            sample.custom_sample_bank = 1;
            sample.bank_specified = false;
            sample.is_layered = false;
        }
    }
}

impl Default for SamplePoint {
    fn default() -> Self {
        Self {
            time: 0.0,
            sample_bank: Self::DEFAULT_SAMPLE_BANK,
            sample_volume: Self::DEFAULT_SAMPLE_VOLUME,
            custom_sample_bank: Self::DEFAULT_CUSTOM_SAMPLE_BANK,
        }
    }
}

impl PartialOrd for SamplePoint {
    fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
        self.time.partial_cmp(&other.time)
    }
}

```

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

### BreakPeriod Struct

Source: https://docs.rs/rosu-map/latest/rosu_map/section/events/struct.BreakPeriod

Represents a break period within a Beatmap, defined by a start and end time.

```APIDOC
## Struct BreakPeriod

### Description
A break section during a `Beatmap`.

### Fields
- **start_time** (f64) - The time at which the break begins.
- **end_time** (f64) - The time at which the break ends.

### Methods
#### `MIN_BREAK_DURATION: f64`
- **Description**: The minimum duration required for a break to have any effect.
- **Type**: Constant

#### `duration(&self) -> f64`
- **Description**: Calculates and returns the duration of the break.
- **Type**: Method

#### `has_effect(&self) -> bool`
- **Description**: Determines whether the break has any effect based on its duration.
- **Type**: Method

### Trait Implementations
- **Clone**: Allows creating copies of `BreakPeriod` instances.
- **Debug**: Enables debugging output for `BreakPeriod` instances.
- **Default**: Provides a default value for `BreakPeriod`.
- **PartialEq**: Allows comparison of `BreakPeriod` instances for equality.
- **Copy**: Indicates that `BreakPeriod` can be copied implicitly.
- **StructuralPartialEq**: Enables structural equality comparisons.
```

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

### Implement Blanket Traits for Generic Types

Source: https://docs.rs/rosu-map/latest/rosu_map/section/hit_objects/hit_samples/struct.SampleBankInfo

Demonstrates blanket implementations of traits like Any, Borrow, BorrowMut, CloneToUninit, From, Into, ToOwned, TryFrom, and TryInto for generic types, which also apply to SampleBankInfo.

```rust
fn type_id(&self) -> TypeId
```

```rust
fn borrow(&self) -> &T
```

```rust
fn borrow_mut(&mut self) -> &mut T
```

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

```rust
fn from(t: T) -> T
```

```rust
fn into(self) -> U
```

```rust
type Owned = T
```

```rust
fn to_owned(&self) -> T
```

```rust
fn clone_into(&self, target: &mut T)
```

```rust
type Error = Infallible
```

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

```rust
type Error = <U as TryFrom<T>>::Error
```

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

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

### Get Total Path Distance (Rust)

Source: https://docs.rs/rosu-map/latest/src/rosu_map/section/hit_objects/slider/curve.rs_search=

Retrieves the total distance of the curve. This is determined by the last element in the lengths array.

```rust
/// The total distance of the [`BorrowedCurve`].
pub fn dist(&self) -> f64 {
    dist(self.lengths)
}

fn dist(lengths: &[f64]) -> f64 {
    lengths.last().copied().unwrap_or(0.0)
}
```

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

### SamplePoint Constants and Constructor in Rust

Source: https://docs.rs/rosu-map/latest/rosu_map/section/timing_points/struct.SamplePoint_search=std%3A%3Avec

Provides default values for SamplePoint and a constructor function. These are useful for initializing SamplePoint instances with standard or custom settings.

```rust
pub const DEFAULT_SAMPLE_BANK: SampleBank = SampleBank::Normal;
pub const DEFAULT_SAMPLE_VOLUME: i32 = 100i32;
pub const DEFAULT_CUSTOM_SAMPLE_BANK: i32 = 0i32;

pub fn new( time: f64,
 sample_bank: SampleBank,
 sample_volume: i32,
 custom_sample_bank: i32,
) -> Self
```

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

### HitObjectSpinner Struct

Source: https://docs.rs/rosu-map/latest/rosu_map/section/hit_objects/struct.HitObjectSpinner_search=std%3A%3Avec

Represents a spinner hit object in osu! maps. It includes position, duration, and whether it starts a new combo.

```APIDOC
## Struct HitObjectSpinner

### Description
A spinner `HitObject`.

### Fields
- **pos** (Pos) - The position of the spinner.
- **duration** (f64) - The duration of the spinner in seconds.
- **new_combo** (bool) - Indicates if this hit object starts a new combo.

### Trait Implementations
- **Clone**: Allows creating a copy of the `HitObjectSpinner`.
- **Debug**: Enables formatting the `HitObjectSpinner` for debugging.
- **PartialEq**: Allows comparing two `HitObjectSpinner` instances for equality.
- **Copy**: Indicates that `HitObjectSpinner` can be copied by value.
- **StructuralPartialEq**: Provides structural equality comparison.
- **Freeze, RefUnwindSafe, Send, Sync, Unpin, UnwindSafe**: Auto-implemented traits for thread safety and memory management.
- **Any**: Allows treating `HitObjectSpinner` as any type.
- **Borrow<T>, BorrowMut<T>**: Enables borrowing the `HitObjectSpinner` immutably or mutably.
- **CloneToUninit**: Experimental API for cloning to uninitialized memory.
- **From<T>, Into<U>**: Conversion traits.
- **ToOwned**: Creates an owned version of the `HitObjectSpinner`.
- **TryFrom<U>, TryInto<U>**: Traits for fallible conversions.
```

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

### Clone, Debug, Default, and PartialEq Implementations (Rust)

Source: https://docs.rs/rosu-map/latest/rosu_map/section/general/type.GeneralState_search=

Standard trait implementations for the General struct, including Clone for creating copies, Debug for printing, Default for creating a default instance, and PartialEq for equality comparisons.

```rust
impl Clone for General {
    fn clone(&self) -> General { /* ... */ }
    fn clone_from(&mut self, source: &Self) { /* ... */ }
}

impl Debug for General {
    fn fmt(&self, f: &mut Formatter<'_>) -> Result {
        // ...
    }
}

impl Default for General {
    fn default() -> Self { /* ... */ }
}

impl PartialEq for General {
    fn eq(&self, other: &General) -> bool { /* ... */ }
    fn ne(&self, other: &Rhs) -> bool { /* ... */ }
}

impl StructuralPartialEq for General {}
```

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

### Get Type ID of any Type T in Rust

Source: https://docs.rs/rosu-map/latest/rosu_map/section/hit_objects/struct.HitObject

Implements the Any trait for generic type T, providing a method to retrieve the TypeId of the object.

```rust
fn type_id(&self) -> TypeId {
    // Implementation details omitted for brevity
}
```

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

### Implement PartialEq for SampleBankInfo

Source: https://docs.rs/rosu-map/latest/rosu_map/section/hit_objects/hit_samples/struct.SampleBankInfo

Implements the PartialEq trait for SampleBankInfo, allowing for equality comparisons between two SampleBankInfo instances. This includes methods for checking equality (`eq`) and inequality (`ne`).

```rust
fn eq(&self, other: &SampleBankInfo) -> bool
```

```rust
fn ne(&self, other: &Rhs) -> bool
```

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

### Encode Breaks in Rust

Source: https://docs.rs/rosu-map/latest/src/rosu_map/encode.rs

Iterates through break points and writes their start and end times to a writer. This function is part of the encoding process for game data.

```rust
fn encode_breaks<W: Write>(&self, writer: &mut W) -> IoResult<()>
{
    for b in self.breaks.iter() {
        writeln!(
            writer,
            "{},{},",
            EventType::Break as i32,
            b.start_time,
            b.end_time
        )?;
    }

    Ok(())
}
```

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

### Fallible Type Conversion (TryFrom/TryInto)

Source: https://docs.rs/rosu-map/latest/rosu_map/section/timing_points/struct.ControlPoints_search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Documentation for the `TryFrom` and `TryInto` traits, enabling fallible conversions between types.

```APIDOC
### `impl<T, U> TryFrom<U> for T`

#### Description
Trait for fallible conversion from one type to another.

#### Type `Error`
- **Error** (type) - The type returned in the event of a conversion error. This is typically `std::convert::Infallible` if the conversion is always possible.

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

##### Description
Performs the conversion.

##### Method
`try_from`

##### Endpoint
N/A (Associated function)

##### Parameters
- **value** (U) - The value to convert.

##### Request Example
```rust
use std::convert::TryFrom;

let result: Result<i32, _> = i32::try_from(10u8);
```

##### Response
- **Result<T, Error>** - A `Result` containing the converted value or an error.

### `impl<T, U> TryInto<U> for T`

#### Description
Trait for fallible conversion from one type to another, providing a convenient method syntax.

#### Type `Error`
- **Error** (type) - The type returned in the event of a conversion error. This is determined by the `TryFrom` implementation for the target type.

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

##### Description
Performs the conversion.

##### Method
`try_into`

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

##### Parameters
- **self** (T) - The value to convert.

##### Request Example
```rust
use std::convert::TryInto;

let value: u8 = 10;
let result: Result<i32, _> = value.try_into();
```

##### Response
- **Result<U, Error>** - A `Result` containing the converted value or an error.
```

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

### CloneToUninit

Source: https://docs.rs/rosu-map/latest/rosu_map/section/general/struct.General_search=

Provides a method to perform copy-assignment from self to a mutable pointer destination. This is an experimental, nightly-only API.

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

### Description
Performs copy-assignment from `self` to `dest`.

### Method
`unsafe fn`

### Endpoint
N/A (Trait method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (N/A)
This is an unsafe function that modifies memory directly.

#### Response Example
None
```

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

### Check if HitObjectKind Starts a New Combo

Source: https://docs.rs/rosu-map/latest/rosu_map/section/hit_objects/enum.HitObjectKind

Determines if a HitObjectKind initiates a new combo. This is a common check when processing beatmap data.

```rust
pub const fn new_combo(&self) -> bool
```

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

### CloneToUninit

Source: https://docs.rs/rosu-map/latest/rosu_map/section/general/struct.General_search=std%3A%3Avec

The `CloneToUninit` trait is an unstable, nightly-only API for performing copy-assignment from `self` to a raw pointer `dest`.

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

### Description
Performs copy-assignment from `self` to `dest`.

### Method
`clone_to_uninit`

### Parameters
- **self** (&self) - Required - The source value.
- **dest** (*mut u8) - Required - A mutable raw pointer to the destination memory.

### Response
This function does not return a value, but performs an operation in place.

### Request Example
```json
{
  "example": "source_value"
}
```

### Response Example
```json
{
  "example": "destination_memory_updated"
}
```
```

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

### Get End Time of HitObject in Rust

Source: https://docs.rs/rosu-map/latest/rosu_map/section/hit_objects/struct.HitObject

Calculates and returns the end time of a HitObject. For sliders, this may involve curve calculations.

```rust
pub fn end_time(&mut self) -> f64 {
    // Implementation details omitted for brevity
}
```

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

### SamplePoint Constants and Methods in Rust

Source: https://docs.rs/rosu-map/latest/rosu_map/section/timing_points/struct.SamplePoint

Provides default values and utility methods for the SamplePoint struct. Includes constants for default sample bank, volume, and custom sample bank, along with methods for creating new points and checking for redundancy.

```rust
pub const DEFAULT_SAMPLE_BANK: SampleBank = SampleBank::Normal;
pub const DEFAULT_SAMPLE_VOLUME: i32 = 100i32;
pub const DEFAULT_CUSTOM_SAMPLE_BANK: i32 = 0i32;

pub fn new( time: f64, sample_bank: SampleBank, sample_volume: i32, custom_sample_bank: i32, ) -> Self;

pub fn is_redundant(&self, existing: &Self) -> bool;

pub fn apply(&self, sample: &mut HitSampleInfo);
```

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

### Get Slider Span Count in Rust

Source: https://docs.rs/rosu-map/latest/rosu_map/section/hit_objects/struct.HitObjectSlider_search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Returns the number of spans for a HitObjectSlider. This is a constant function, meaning it does not require mutable access to self.

```rust
pub const fn span_count(&self) -> i32
```

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

### Get End Time with Curve Buffers in Rust

Source: https://docs.rs/rosu-map/latest/rosu_map/section/hit_objects/struct.HitObject

Calculates the end time of a HitObject, utilizing provided CurveBuffers for efficiency, especially with sliders.

```rust
pub fn end_time_with_bufs(&mut self, bufs: &mut CurveBuffers) -> f64 {
    // Implementation details omitted for brevity
}
```

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

### Implement TryFrom and TryInto for Generic Types in Rust

Source: https://docs.rs/rosu-map/latest/rosu_map/section/hit_objects/struct.HitObjects_search=

Demonstrates the implementation of `TryFrom` and `TryInto` traits for generic types `T` and `U`. These traits facilitate fallible conversions between types, returning a `Result` to indicate success or failure.

```rust
impl<T, U> TryFrom<U> for T
where U: Into<T>,
Source§

type Error = Infallible
The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
Performs the conversion.
Source§
```

```rust
impl<T, U> TryInto<U> for T
where U: TryFrom<T>,
Source§

type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
Performs the conversion.
Source§
```

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

### Implement SampleBankInfo parsing in Rust

Source: https://docs.rs/rosu-map/latest/src/rosu_map/section/hit_objects/hit_samples.rs_search=

Provides functionality to parse sample bank information from a string split by characters. It extracts and stores details like filenames, normal and addition sample banks, volume, and custom sample bank IDs. Includes error handling for missing information.

```rust
/// Sample info of a [`HitObject`] to convert [`HitSoundType`] into a [`Vec`]
/// of [`HitSampleInfo`].
///
/// [`HitObject`]: crate::section::hit_objects::HitObject
#[derive(Clone, Debug, Default, PartialEq, Eq)]
pub struct SampleBankInfo {
    pub filename: Option<String>,
    pub bank_for_normal: Option<SampleBank>,
    pub bank_for_addition: Option<SampleBank>,
    pub volume: i32,
    pub custom_sample_bank: i32,
}

impl SampleBankInfo {
    /// Read and store custom sample banks.
    pub fn read_custom_sample_banks(
        &mut self,
        mut split: Split<'_, char>,
        banks_only: bool,
    ) -> Result<(), ParseSampleBankInfoError> {
        let Some(first) = split.next().filter(|s| !s.is_empty()) else {
            return Ok(());
        };

        let bank = i32::parse(first)?.try_into().unwrap_or(SampleBank::Normal);

        let add_bank = split
            .next()
            .ok_or(ParseSampleBankInfoError::MissingInfo)?
            .parse_num::<i32>()?
            .try_into()
            .unwrap_or(SampleBank::Normal);

        let normal_bank = (bank != SampleBank::None).then_some(bank);
        let add_bank = (add_bank != SampleBank::None).then_some(add_bank);

        self.bank_for_normal = normal_bank;
        self.bank_for_addition = add_bank.or(normal_bank);

        if banks_only {
            return Ok(());
        }

        if let Some(next) = split.next() {
            self.custom_sample_bank = next.parse_num()?;
        }

        if let Some(next) = split.next() {
            self.volume = cmp::max(0, next.parse_num()?);
        }

        self.filename = split.next().map(str::to_owned);

        Ok(())
    }

    /// Convert a [`HitSoundType`] into a [`Vec`] of [`HitSampleInfo`].
    pub fn convert_sound_type(self, sound_type: HitSoundType) -> Vec<HitSampleInfo> {
        let mut sound_types = Vec::new();

        if let Some(filename) = self.filename.filter(|filename| !filename.is_empty()) {
            sound_types.push(HitSampleInfo::new(
                HitSampleInfoName::File(filename),
                None,
            ));
        }
        sound_types
    }
}
```

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

### Get HitSampleInfo Filename in Rust

Source: https://docs.rs/rosu-map/latest/rosu_map/section/hit_objects/hit_samples/struct.HitSampleInfo_search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Implements the `lookup_name` method for HitSampleInfo. This method returns the filename with the highest preference that can be used as a source for the sample information.

```rust
pub const fn lookup_name(&self) -> LookupName<'_>
```

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

### Check if HitObject Starts a New Combo in Rust

Source: https://docs.rs/rosu-map/latest/rosu_map/section/hit_objects/struct.HitObject

Determines if a HitObject initiates a new combo sequence. This is a common check in rhythm game logic.

```rust
pub const fn new_combo(&self) -> bool {
    // Implementation details omitted for brevity
}
```

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

### take

Source: https://docs.rs/rosu-map/latest/rosu_map/section/hit_objects/struct.SliderEventsIter_search=std%3A%3Avec

Creates an iterator that yields the first `n` elements.

```APIDOC
## GET /iterator/take

### Description
Creates an iterator that yields the first `n` elements, or fewer if the underlying iterator ends sooner.

### Method
GET

### Endpoint
`/iterator/take`

### Parameters
#### Query Parameters
- **n** (usize) - Required - The maximum number of elements to yield.

### Request Example
```json
{
  "iterator_source": "...",
  "n": 3
}
```

### Response
#### Success Response (200)
- **iterator** (iterator) - An iterator yielding at most `n` elements.

#### Response Example
```json
{
  "iterator": "..."
}
```
```

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

### Define HitObject Struct in Rust

Source: https://docs.rs/rosu-map/latest/rosu_map/section/hit_objects/struct.HitObject

Defines the HitObject structure used in the rosu-map library. It contains the start time, type, and sample information for a hit object.

```rust
pub struct HitObject {
    pub start_time: f64,
    pub kind: HitObjectKind,
    pub samples: Vec<HitSampleInfo>,
}
```

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

### CloneToUninit Trait (Nightly/Experimental)

Source: https://docs.rs/rosu-map/latest/rosu_map/section/general/struct.General

This experimental, nightly-only trait allows for unsafe copying of data to an uninitialized memory location. Use with caution.

```APIDOC
## POST /impl/CloneToUninit

### Description
Unsafely copies data from `self` to a provided destination pointer. This is an experimental, nightly-only feature.

### Method
POST

### Endpoint
/impl/CloneToUninit

### Parameters
#### Request Body
- **source** (T) - Required - The value to copy from.
- **destination** (*mut u8) - Required - A mutable pointer to the destination memory location.

### Request Example
{
  "source": "<value of T>",
  "destination": "<pointer address>"
}

### Response
#### Success Response (200)
Indicates the operation completed without immediate error. No specific data is returned.

#### Response Example
{
  "status": "success"
}
```

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

### Implement TryFrom and TryInto for Conversions in Rust

Source: https://docs.rs/rosu-map/latest/rosu_map/section/hit_objects/struct.HitObjects

Provides blanket implementations for `TryFrom<U>` for `T` where `U` implements `Into<T>`, and `TryInto<U>` for `T` where `U` implements `TryFrom<T>`. These allow fallible conversions between types.

```rust
impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
Performs the conversion.
```

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

### Get Default Colors in Rust

Source: https://docs.rs/rosu-map/latest/rosu_map/section/colors/struct.Colors

Provides a default implementation for the `Colors` struct, allowing it to be created with standard default values. This is useful when no custom colors are specified.

```rust
impl Default for Colors {
    fn default() -> Colors {
        // Returns the default value for Colors
        unimplemented!()
    }
}
```

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

### CloneToUninit Trait Implementation (Nightly Only)

Source: https://docs.rs/rosu-map/latest/rosu_map/struct.Beatmap_search=u32+-%3E+bool

An experimental, nightly-only API for performing copy-assignment from `self` to a mutable pointer `dest`.

```APIDOC
## impl<T> CloneToUninit for T

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

### Method
`clone_to_uninit`

### Endpoint
N/A (Trait implementation)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
N/A

### Response
#### Success Response (200)
None (This is an unsafe operation)

#### Response Example
N/A
```

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

### Manage SliderPath Curve Calculation (Rust)

Source: https://docs.rs/rosu-map/latest/rosu_map/section/hit_objects/struct.SliderPath_search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Includes methods to clear the cached curve, forcing recalculation on the next access, and to get the expected distance of the slider path.

```rust
pub const fn expected_dist(&self) -> Option<f64>
pub fn expected_dist_mut(&mut self) -> &mut Option<f64>
pub fn clear_curve(&mut self)
```

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

### Implement CloneToUninit for Clone Types in Rust (Nightly)

Source: https://docs.rs/rosu-map/latest/rosu_map/section/hit_objects/struct.HitObjects

This is a nightly-only experimental API that implements `CloneToUninit` for types `T` that implement `Clone`. It provides an unsafe method `clone_to_uninit` for copying data to an uninitialized memory location.

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

unsafe fn clone_to_uninit(&self, dest: *mut u8)
Performs copy-assignment from `self` to `dest`. Read more
```

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

### Implement Iterator Trait for SliderEventsIter in Rust

Source: https://docs.rs/rosu-map/latest/rosu_map/section/hit_objects/struct.SliderEventsIter_search=

Provides the core iterator functionality for SliderEventsIter, including methods to get the next event, estimate remaining elements, and consume the iterator.

```rust
impl<'ticks_buf> Iterator for SliderEventsIter<'ticks_buf> {
    type Item = SliderEvent;

    fn next(&mut self) -> Option<Self::Item> {
        // ... implementation ...
    }

    fn size_hint(&self) -> (usize, Option<usize>) {
        // ... implementation ...
    }

    // Other iterator methods like count, last, nth, etc.
}
```

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

### TimingPoint Implementations

Source: https://docs.rs/rosu-map/latest/rosu_map/section/timing_points/struct.TimingPoint_search=std%3A%3Avec

Details the various trait implementations for the TimingPoint struct, including Clone, Debug, Default, PartialEq, PartialOrd, and others.

```APIDOC
## Implementations for TimingPoint

### Trait: Clone
- `clone(&self) -> TimingPoint`: Returns a duplicate of the `TimingPoint`.
- `clone_from(&mut self, source: &Self)`: Performs copy-assignment from `source`.

### Trait: ControlPoint<ControlPoints>
- `check_already_existing(&self, _: &ControlPoints) -> bool`: Checks if `self` is redundant with an existing control point.
- `add(self, control_points: &mut ControlPoints)`: Adds the control point into the collection.

### Trait: Debug
- `fmt(&self, f: &mut Formatter<'_>) -> Result`: Formats the value using the given formatter.

### Trait: Default
- `default() -> Self`: Returns the default value for `TimingPoint`.

### Trait: PartialEq
- `eq(&self, other: &TimingPoint) -> bool`: Tests for equality between two `TimingPoint` instances.
- `ne(&self, other: &Rhs) -> bool`: Tests for inequality.

### Trait: PartialOrd
- `partial_cmp(&self, other: &Self) -> Option<Ordering>`: Compares two `TimingPoint` instances for ordering.
- `lt(&self, other: &Rhs) -> bool`: Tests if `self` is less than `other`.
- `le(&self, other: &Rhs) -> bool`: Tests if `self` is less than or equal to `other`.
- `gt(&self, other: &Rhs) -> bool`: Tests if `self` is greater than `other`.
- `ge(&self, other: &Rhs) -> bool`: Tests if `self` is greater than or equal to `other`.

### Auto Trait Implementations
- `Freeze`
- `RefUnwindSafe`
- `Send`
- `Sync`
- `Unpin`
- `UnwindSafe`

### Blanket Implementations
- `Any`
- `Borrow<T>`
- `BorrowMut<T>`
- `CloneToUninit` (Nightly-only experimental API)
- `From<T>`
- `Into<U>`
- `ToOwned`
- `TryFrom<U>`
- `TryInto<U>`
```

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

### Parse Time Signature in Rust

Source: https://docs.rs/rosu-map/latest/src/rosu_map/section/timing_points/decode.rs_search=

Parses a time signature from an optional string input. If a string is provided and does not start with '0', it attempts to parse it into a TimeSignature; otherwise, it defaults to a simple quadruple time signature.

```rust
        let mut time_signature = TimeSignature::new_simple_quadruple();

        if let Some(next) = split.next() {
            if !matches!(next.chars().next(), Some('0')) {
                time_signature = TimeSignature::new(next.parse_num()?)?;
            }
        }
```

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

### impl<T> CloneToUninit for T

Source: https://docs.rs/rosu-map/latest/rosu_map/section/timing_points/struct.TimingPoints_search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

An experimental, nightly-only API that performs copy-assignment from `self` to an uninitialized memory location `dest`. Requires `T` to implement `Clone`.

```APIDOC
## POST /clone_to_uninit

### Description
Performs copy-assignment from `self` to `dest`.

### Method
POST

### Endpoint
/clone_to_uninit

### Parameters
#### Request Body
- **self** (T) - Required - The value to clone.
- **dest** (*mut u8) - Required - A raw pointer to the destination memory location.
```

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

### SliderEvent Struct

Source: https://docs.rs/rosu-map/latest/rosu_map/section/hit_objects/struct.SliderEvent_search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Represents a SliderEvent as generated by SliderEventsIter. It contains information about the slider's event type, span index, start time, current time, and progress along the path.

```APIDOC
## Struct SliderEvent

### Description
A `HitObjectSlider` event as generated by `SliderEventsIter`.

### Fields
- **kind** (`SliderEventType`) - The type of slider event.
- **span_idx** (`i32`) - The index of the current span within the slider.
- **span_start_time** (`f64`) - The timestamp when the current span started.
- **time** (`f64`) - The timestamp of the slider event.
- **path_progress** (`f64`) - The progress along the slider's path (0.0 to 1.0).

### Trait Implementations
- **Clone**: Allows creating a copy of a `SliderEvent`.
- **Debug**: Enables formatting `SliderEvent` for debugging purposes.
- **PartialEq**: Allows comparing two `SliderEvent` instances for equality.
- **StructuralPartialEq**: A trait related to structural equality comparison.

### Auto Trait Implementations
- **Freeze**, **RefUnwindSafe**, **Send**, **Sync**, **Unpin**, **UnwindSafe**: These indicate thread safety and memory safety properties of the struct.
```

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

### Default Trait Implementation for General (Rust)

Source: https://docs.rs/rosu-map/latest/rosu_map/section/general/type.GeneralState_search=u32+-%3E+bool

Provides a default implementation for the `General` struct, allowing for the creation of a `General` instance with default values. This simplifies initialization and ensures a predictable starting state.

```rust
impl Default for General {
    fn default() -> Self {
        // Implementation details for default General
        unimplemented!()
    }
}
```

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

### HitSoundType Equality Comparisons

Source: https://docs.rs/rosu-map/latest/rosu_map/section/hit_objects/hit_samples/struct.HitSoundType_search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Details the equality comparison implementations (`PartialEq`) for HitSoundType, both with other `HitSoundType` instances and with `u8` values. This allows for straightforward checks of sound type equality.

```rust
impl PartialEq<u8> for HitSoundType {
    fn eq(&self, other: &u8) -> bool;
    fn ne(&self, other: &Rhs) -> bool;
}

impl PartialEq for HitSoundType {
    fn eq(&self, other: &HitSoundType) -> bool;
    fn ne(&self, other: &Rhs) -> bool;
}

```

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

### Implement Error for ParseEffectFlagsError

Source: https://docs.rs/rosu-map/latest/rosu_map/section/timing_points/struct.ParseEffectFlagsError

Implements the standard `Error` trait for ParseEffectFlagsError. This includes methods like `source` to get the underlying error cause and deprecated methods like `description` and `cause`.

```rust
impl Error for ParseEffectFlagsError {
    fn source(&self) -> Option<&(dyn Error + 'static)>;
    // Deprecated methods:
    // fn description(&self) -> &str;
    // fn cause(&self) -> Option<&dyn Error>;
    // fn provide<'a>(&'a self, request: &mut Request<'a>); // Nightly-only
}
```

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

### Colors Module Documentation

Source: https://docs.rs/rosu-map/latest/rosu_map/section/colors/index_search=

Provides documentation for the types within the rosu_map::section::colors module, which handle color data from .osu files.

```APIDOC
## Module colors

rosu_map::section::colors

### Description

Types for the `[Colours]` section of `.osu` files.

### Structs

#### Struct: Color

*   **Description**: Basic RGBA color.

#### Struct: Colors

*   **Description**: Struct containing all data from a `.osu` file’s `[Colours]` section.

#### Struct: CustomColor

*   **Description**: A combination of a `Color` and a name.

### Enums

#### Enum: ColorsKey

*   **Description**: All valid keys within a `.osu` file’s `[Colours]` section.

#### Enum: ParseColorsError

*   **Description**: All the ways that parsing a `.osu` file into `Colors` can fail.

### Type Aliases

#### Type Alias: ColorsState

*   **Description**: The parsing state for `Colors` in `DecodeBeatmap`.
```

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

### Implement PartialEq for ControlPoints in Rust

Source: https://docs.rs/rosu-map/latest/rosu_map/section/timing_points/struct.ControlPoints_search=std%3A%3Avec

Allows for equality comparison between two ControlPoints instances. This is useful for testing and verifying beatmap data integrity.

```rust
fn eq(&self, other: &ControlPoints) -> bool
fn ne(&self, other: &Rhs) -> bool
```

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

### Get TypeId for Generic Type T in Rust

Source: https://docs.rs/rosu-map/latest/rosu_map/section/hit_objects/struct.HitObjects_search=

Demonstrates the `type_id` function, which is part of the `Any` trait implementation. This function returns the `TypeId` of the instance it's called on, enabling runtime identification of the type.

```rust
fn type_id(&self) -> TypeId
Gets the `TypeId` of `self`. Read more
Source§
```
Tokens:
Raw