Struct YamlDocument 

pub struct YamlDocument { /* private fields */ }

A Unity YAML document containing one or more Unity objects

Implementations

impl YamlDocument

pub fn new() -> YamlDocument

Create a new empty YAML document

pub fn load_yaml<P>( path: P, _preserve_types: bool, ) -> Result<YamlDocument, UnityAssetError>

where P: AsRef<Path>,

Load a Unity YAML file

Arguments

• path - Path to the YAML file to load
• preserve_types - If true, try to preserve int/float types instead of converting all to strings

Examples

use unity_asset_yaml::YamlDocument;

let doc = YamlDocument::load_yaml("ProjectSettings.asset", false)?;

pub fn line_ending(&self) -> LineEnding

Get the line ending style

pub fn set_line_ending(&mut self, newline: LineEnding)

Set the line ending style

pub fn version(&self) -> Option<&str>

Get the YAML version

pub fn yaml_metadata(&self) -> &HashMap<String, String>

Get the YAML metadata

pub fn save(&self) -> Result<(), UnityAssetError>

Save document to its original file

This method saves the document back to the file it was loaded from. If the document was not loaded from a file, this will return an error.

Examples

use unity_asset_yaml::YamlDocument;

let mut doc = YamlDocument::load_yaml("ProjectSettings.asset", false)?;
// ... modify the document ...
doc.save()?;  // Save back to original file

pub fn save_to<P>(&self, path: P) -> Result<(), UnityAssetError>

where P: AsRef<Path>,

Save document to a specific file

This method serializes the document to Unity YAML format and saves it to the specified file path.

Examples

use unity_asset_yaml::YamlDocument;

let doc = YamlDocument::load_yaml("ProjectSettings.asset", false)?;
doc.save_to("ProjectSettings_backup.asset")?;

pub fn dump_yaml(&self) -> Result<String, UnityAssetError>

Get YAML content as string

This method serializes the document to Unity YAML format and returns it as a string without writing to a file.

Examples

use unity_asset_yaml::YamlDocument;

let doc = YamlDocument::load_yaml("ProjectSettings.asset", false)?;
let yaml_string = doc.dump_yaml()?;
println!("{}", yaml_string);

pub fn filter( &self, class_names: Option<&[&str]>, attributes: Option<&[&str]>, ) -> Vec<&UnityClass>

Filter entries by class names and/or attributes

This method provides advanced filtering capabilities similar to the Python reference library’s filter() method.

Arguments

• class_names - Optional list of class names to filter by
• attributes - Optional list of attribute names that entries must have

Examples

use unity_asset_yaml::YamlDocument;

let doc = YamlDocument::load_yaml("scene.unity", false)?;

// Find all GameObjects
let gameobjects = doc.filter(Some(&["GameObject"]), None);

// Find all objects with m_Enabled property
let enabled_objects = doc.filter(None, Some(&["m_Enabled"]));

// Find MonoBehaviours with m_Script property
let scripts = doc.filter(Some(&["MonoBehaviour"]), Some(&["m_Script"]));

pub fn get( &self, class_name: Option<&str>, attributes: Option<&[&str]>, ) -> Result<&UnityClass, UnityAssetError>

Get a single entry by class name and/or attributes

This method returns the first entry that matches the criteria. Returns an error if no matching entry is found or if multiple entries match.

Arguments

• class_name - Optional class name to match
• attributes - Optional list of attribute names that the entry must have

Examples

use unity_asset_yaml::YamlDocument;

let doc = YamlDocument::load_yaml("scene.unity", false)?;

// Get the first GameObject
let gameobject = doc.get(Some("GameObject"), None)?;

// Get an object with specific attributes
let script = doc.get(Some("MonoBehaviour"), Some(&["m_Script", "m_Enabled"]))?;

Trait Implementations

impl Debug for YamlDocument

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

Formats the value using the given formatter.

impl Default for YamlDocument

fn default() -> YamlDocument

Returns the “default value” for a type.

impl UnityDocument for YamlDocument

fn entry(&self) -> Option<&UnityClass>

Get the first entry (main object) in the document

fn entry_mut(&mut self) -> Option<&mut UnityClass>

Get a mutable reference to the first entry

fn entries(&self) -> &[UnityClass]

Get all entries in the document

fn entries_mut(&mut self) -> &mut Vec<UnityClass>

Get mutable access to all entries

fn add_entry(&mut self, entry: UnityClass)

Add a new Unity object to the document

fn file_path(&self) -> Option<&Path>

Get the file path this document was loaded from

fn save(&self) -> Result<(), UnityAssetError>

Save the document back to its original file

fn save_to<P>(&self, path: P) -> Result<(), UnityAssetError>

where P: AsRef<Path>,

Save the document to a specific file

fn format(&self) -> DocumentFormat

Get the document format

fn filter_by_class(&self, class_name: &str) -> Vec<&UnityClass>

Filter entries by class name

fn filter_by_classes(&self, class_names: &[&str]) -> Vec<&UnityClass>

Filter entries by multiple class names

fn filter<F>(&self, predicate: F) -> Vec<&UnityClass>

where F: Fn(&UnityClass) -> bool,

Filter entries by a custom predicate

fn find_by_class_and_property( &self, class_name: &str, property: &str, ) -> Option<&UnityClass>

Find a single entry by class name and optional property filter

fn is_empty(&self) -> bool

Check if the document is empty

fn len(&self) -> usize

Get the number of entries in the document