Struct VmfFile

pub struct VmfFile {
    pub path: Option<String>,
    pub versioninfo: VersionInfo,
    pub visgroups: VisGroups,
    pub viewsettings: ViewSettings,
    pub world: World,
    pub entities: Entities,
    pub hiddens: Entities,
    pub cameras: Cameras,
    pub cordons: Cordons,
}

Represents a parsed VMF file.

Fields

path: Option<String>

The path to the VMF file, if known.

versioninfo: VersionInfo

The version info of the VMF file.

visgroups: VisGroups

The visgroups in the VMF file.

viewsettings: ViewSettings

The view settings in the VMF file.

world: World

The world data in the VMF file.

entities: Entities

The entities in the VMF file.

hiddens: Entities

The hidden entities in the VMF file.

cameras: Cameras

The camera data in the VMF file.

cordons: Cordons

The cordon data in the VMF file.

Implementations

impl VmfFile

pub fn parse(content: &str) -> VmfResult<Self>

Parses a VMF file from a string.

Arguments

• content - The string content of the VMF file.

Returns

A VmfResult containing the parsed VmfFile or a VmfError if parsing fails.

Examples

use vmf_forge::VmfFile;

let vmf_content = r#"
versioninfo
{
    "editorversion" "400"
    "editorbuild" "8000"
    "mapversion" "1"
    "formatversion" "100"
    "prefab" "0"
}
"#;

let vmf_file = VmfFile::parse(vmf_content);
assert!(vmf_file.is_ok());

pub fn parse_file(file: &mut File) -> VmfResult<Self>

Parses a VMF file from a File.

Arguments

• file - The File to read from.

Returns

A VmfResult containing the parsed VmfFile or a VmfError if parsing fails.

Examples

use vmf_forge::VmfFile;
use std::fs::File;

let mut file = File::open("your_map.vmf").unwrap();
let vmf_file = VmfFile::parse_file(&mut file);
assert!(vmf_file.is_ok());

pub fn open(path: impl AsRef<Path>) -> VmfResult<Self>

Opens and parses a VMF file from a file path.

Arguments

• path - The path to the VMF file.

Returns

A VmfResult containing the parsed VmfFile or a VmfError if an error occurs.

Examples

use vmf_forge::VmfFile;

let vmf_file = VmfFile::open("your_map.vmf");
assert!(vmf_file.is_ok());

pub fn save(&self, path: impl AsRef<Path>) -> VmfResult<()>

Saves the VmfFile to a file at the specified path.

Arguments

• path - The path to save the VMF file to.

Returns

A VmfResult indicating success or a VmfError if an error occurs.

Examples

use vmf_forge::VmfFile;

let vmf_file = VmfFile::open("your_map.vmf").unwrap();
let result = vmf_file.save("new_map.vmf");
assert!(result.is_ok());

pub fn to_vmf_string(&self) -> String

Converts the VmfFile to a string in VMF format.

Returns

A string representing the VmfFile in VMF format.

Trait Implementations

impl Clone for VmfFile

fn clone(&self) -> VmfFile

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for VmfFile

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

Formats the value using the given formatter.

impl Default for VmfFile

fn default() -> VmfFile

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for VmfFile

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for VmfFile

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.