Struct rosu_storyboard::Storyboard

pub struct Storyboard {
    pub format_version: i32,
    pub use_skin_sprites: bool,
    pub background_file: String,
    pub breaks: Vec<BreakPeriod>,
    pub layers: HashMap<String, Layer>,
    /* private fields */
}

The storyboard of a beatmap.

Fields

format_version: i32

use_skin_sprites: bool

background_file: String

breaks: Vec<BreakPeriod>

layers: HashMap<String, Layer>

Implementations

impl Storyboard

pub fn encode_to_path<P: AsRef<Path>>(&self, path: P) -> IoResult<()>

Encode a Storyboard into content of a .osb file and store it at the given path.

pub fn encode_to_string(&self) -> IoResult<String>

Encode a Storyboard into content of a .osb file and store it into a String.

pub fn encode<W: Write>(&self, writer: W) -> IoResult<()>

Encode a Storyboard into content of a .osb file.

impl Storyboard

pub fn from_bytes(bytes: &[u8]) -> Result<Self, Error>

pub fn from_path(path: impl AsRef<Path>) -> Result<Self, Error>

pub fn get_layer(&mut self, name: &str) -> &mut Layer

Return the Layer with the given name.

If no layer has that name, a new one is created.

pub fn try_get_layer(&self, name: &str) -> Option<&Layer>

Return the Layer with the given name.

If no layer has that name, return None.

pub fn earliest_event_time(&self) -> Option<f64>

pub fn latest_event_time(&self) -> Option<f64>

pub fn has_drawable(&self) -> bool

Trait Implementations

impl Clone for Storyboard

fn clone(&self) -> Storyboard

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Storyboard

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

Formats the value using the given formatter.

impl DecodeBeatmap for Storyboard

type Error = ParseStoryboardError

Error type in case something goes wrong while parsing.

type State = StoryboardState

The parsing state which will be updated on each line and turned into Self at the end.

fn should_skip_line(line: &str) -> bool

Whether a line should not be forwarded to the parsing methods.

fn parse_general(state: &mut Self::State, line: &str) -> Result<(), Self::Error>

Update the state based on a line of the [General] section.

fn parse_editor(_: &mut Self::State, _: &str) -> Result<(), Self::Error>

Update the state based on a line of the [Editor] section.

fn parse_metadata(_: &mut Self::State, _: &str) -> Result<(), Self::Error>

Update the state based on a line of the [Metadata] section.

fn parse_difficulty(_: &mut Self::State, _: &str) -> Result<(), Self::Error>

Update the state based on a line of the [Difficulty] section.

fn parse_events(state: &mut Self::State, line: &str) -> Result<(), Self::Error>

Update the state based on a line of the [Events] section.

fn parse_timing_points(_: &mut Self::State, _: &str) -> Result<(), Self::Error>

Update the state based on a line of the [TimingPoints] section.

fn parse_colors(_: &mut Self::State, _: &str) -> Result<(), Self::Error>

Update the state based on a line of the [Colours] section.

fn parse_hit_objects(_: &mut Self::State, _: &str) -> Result<(), Self::Error>

Update the state based on a line of the [HitObjects] section.

fn parse_variables( state: &mut Self::State, line: &str ) -> Result<(), Self::Error>

Update the state based on a line of the [Variables] section.

fn parse_catch_the_beat(_: &mut Self::State, _: &str) -> Result<(), Self::Error>

Update the state based on a line of the [CatchTheBeat] section.

fn parse_mania(_: &mut Self::State, _: &str) -> Result<(), Self::Error>

Update the state based on a line of the [Mania] section.

fn decode<R>(src: R) -> Result<Self, Error>

where R: BufRead,

The key method to read and parse content of a .osu file into Self.

impl Default for Storyboard

fn default() -> Self

Returns the “default value” for a type.

impl From<StoryboardState> for Storyboard

fn from(state: StoryboardState) -> Self

Converts to this type from the input type.

impl FromStr for Storyboard

type Err = Error

The associated error which can be returned from parsing.

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

Parses a string s to return a value of this type.

impl PartialEq for Storyboard

fn eq(&self, other: &Storyboard) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Storyboard