Struct SaveBuffer 

pub struct SaveBuffer {
    pub world: WorldId,
    pub context: Option<u64>,
    pub id: u64,
    pub offset: u64,
    pub size: Option<u64>,
    pub directory: String,
    pub file_name: Option<String>,
}

Available on crate feature mcp and non-WebAssembly only.

Arguments for saving a buffer to a file.

Fields

world: WorldId

The world to drive: "Host" for the world the transport thread itself holds, or {"Handle": bits} for a world a host entity carries.

context: Option<u64>

Any entity carrying the world’s render context, as its u64 bits. Omit when the world holds exactly one.

id: u64

The buffer’s id, as list_resources reports it.

offset: u64

The byte offset to read from.

size: Option<u64>

How many bytes to read; the rest of the buffer when omitted.

directory: String

The directory to write the file into; created when it does not exist.

file_name: Option<String>

The file name to write; it is given a .bin extension when it carries none.

Trait Implementations

impl Debug for SaveBuffer

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SaveBuffer

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for SaveBuffer

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.