Trait Visit

Source

pub trait Visit {
    // Required method
    fn visit(
        &mut self,
        name: &str,
        visitor: &mut Visitor,
    ) -> Result<(), VisitError>;
}

Expand description

Trait of types that can be read from a Visitor or written to a Visitor.

Required Methods§

Source

fn visit(&mut self, name: &str, visitor: &mut Visitor) -> Result<(), VisitError>

Read or write this value, depending on whether Visitor::is_reading() is true or false.

§In Write Mode

The given name is a key to identify where this value will be stored in the visitor. Whether this name indicates a field or a region is determined by the value being visited. No two regions can exist with the same name as children of a single node, and no two fields can exist with the same name within a single node, but a region may share the same name as a field. If a name clash occurs, then an error is returned. Otherwise the value is written into the Visitor data at the given name.

§In Read Mode

The given name is a key to identify where this value should be found the visitor. Whether the name indicates a field or a region is determined by the the value being visited. If the field or region is not found with the given name then an error is returned. Otherwise the value being visited will be mutated to match the data in the visitor.

§Buiding a Complex Value out of Multiple Fields

If representing this value requires more than one field, Visitor::enter_region can be used to create a new node within the visitor with the given name, and the fields of this value can then read from or write to that node using the returned Visitor without risk of name clashes.

See the documentation for the Visit derive macro for examples of how to implement Visit for some simple types.

§Abnormal Implementations

Types with special needs may choose to read and write in unusual ways. In addition to choosing whether they will store their data in a region or a field, a value might choose to do neither. A value may also choose to attempt to read its data in multiple ways so as to remain backwards-compatible with older versions where the format of data storage may be different.

See crate::variable::InheritableVariable::visit for an example of an abnormal implementation of Visit.

Visit

Trait Visit Copy item path

Required Methods§

fn visit(&mut self, name: &str, visitor: &mut Visitor) -> Result<(), VisitError>

§In Write Mode

§In Read Mode

§Buiding a Complex Value out of Multiple Fields

§Abnormal Implementations

Implementations on Foreign Types§

impl Visit for bool

fn visit(&mut self, name: &str, visitor: &mut Visitor) -> Result<(), VisitError>

impl Visit for char

fn visit(&mut self, name: &str, visitor: &mut Visitor) -> Result<(), VisitError>

impl Visit for f32

fn visit(&mut self, name: &str, visitor: &mut Visitor) -> Result<(), VisitError>

impl Visit for f64

fn visit(&mut self, name: &str, visitor: &mut Visitor) -> Result<(), VisitError>

impl Visit for i8

fn visit(&mut self, name: &str, visitor: &mut Visitor) -> Result<(), VisitError>

impl Visit for i16

fn visit(&mut self, name: &str, visitor: &mut Visitor) -> Result<(), VisitError>

impl Visit for i32

fn visit(&mut self, name: &str, visitor: &mut Visitor) -> Result<(), VisitError>

impl Visit for i64

fn visit(&mut self, name: &str, visitor: &mut Visitor) -> Result<(), VisitError>

impl Visit for isize

fn visit(&mut self, name: &str, visitor: &mut Visitor) -> Result<(), VisitError>

impl Visit for u8

fn visit(&mut self, name: &str, visitor: &mut Visitor) -> Result<(), VisitError>

impl Visit for u16

fn visit(&mut self, name: &str, visitor: &mut Visitor) -> Result<(), VisitError>

impl Visit for u32

fn visit(&mut self, name: &str, visitor: &mut Visitor) -> Result<(), VisitError>

impl Visit for u64

fn visit(&mut self, name: &str, visitor: &mut Visitor) -> Result<(), VisitError>

impl Visit for usize

fn visit(&mut self, name: &str, visitor: &mut Visitor) -> Result<(), VisitError>

impl Visit for String

fn visit(&mut self, name: &str, visitor: &mut Visitor) -> Result<(), VisitError>

impl Visit for PathBuf

fn visit(&mut self, name: &str, visitor: &mut Visitor) -> Result<(), VisitError>

impl Visit for GenericBuffer

fn visit(&mut self, name: &str, visitor: &mut Visitor) -> Result<(), VisitError>

impl Visit for StreamingBufferwhere GenericBuffer: Visit,

fn visit(&mut self, name: &str, visitor: &mut Visitor) -> Result<(), VisitError>

impl Visit for SoundContextwhere Option<Arc<Mutex<State>>>: Visit,

fn visit(&mut self, name: &str, visitor: &mut Visitor) -> Result<(), VisitError>

impl Visit for State

fn visit(&mut self, name: &str, visitor: &mut Visitor) -> Result<(), VisitError>

impl Visit for State

fn visit(&mut self, name: &str, visitor: &mut Visitor) -> Result<(), VisitError>

impl Visit for Listenerwhere Matrix<f32, Const<3>, Const<3>, ArrayStorage<f32, 3, 3>>: Visit, Matrix<f32, Const<3>, Const<1>, ArrayStorage<f32, 3, 1>>: Visit,

fn visit(&mut self, name: &str, visitor: &mut Visitor) -> Result<(), VisitError>

impl Visit for SoundSourcewhere String: Visit, Option<Resource<SoundBuffer>>: Visit, f64: Visit, f32: Visit, bool: Visit, Status: Visit, Matrix<f32, Const<3>, Const<1>, ArrayStorage<f32, 3, 1>>: Visit,

fn visit(&mut self, name: &str, visitor: &mut Visitor) -> Result<(), VisitError>

impl<K, S> Visit for HashSet<K, S>where K: Visit + Default + Clone + Hash + Eq, S: BuildHasher + Clone,

fn visit(&mut self, name: &str, visitor: &mut Visitor) -> Result<(), VisitError>

impl<K, V, S> Visit for HashMap<K, V, S>where K: Visit + Default + Clone + Hash + Eq, V: Visit + Default, S: BuildHasher + Clone,

fn visit(&mut self, name: &str, visitor: &mut Visitor) -> Result<(), VisitError>

impl<T> Visit for Option<T>where T: Default + Visit + 'static,

fn visit(&mut self, name: &str, visitor: &mut Visitor) -> Result<(), VisitError>

impl<T> Visit for Box<T>where T: Visit,

fn visit(&mut self, name: &str, visitor: &mut Visitor) -> Result<(), VisitError>

impl<T> Visit for Rc<T>where T: Visit + 'static,

fn visit(&mut self, name: &str, visitor: &mut Visitor) -> Result<(), VisitError>

impl<T> Visit for Weak<T>where T: Default + Visit + 'static,

fn visit(&mut self, name: &str, visitor: &mut Visitor) -> Result<(), VisitError>

impl<T> Visit for Arc<T>where T: Visit + Send + Sync + 'static,

fn visit(&mut self, name: &str, visitor: &mut Visitor) -> Result<(), VisitError>

impl<T> Visit for Weak<T>where T: Default + Visit + Send + Sync + 'static,

fn visit(&mut self, name: &str, visitor: &mut Visitor) -> Result<(), VisitError>

impl<T> Visit for Vec<T>where T: Default + Visit + 'static,

fn visit(&mut self, name: &str, visitor: &mut Visitor) -> Result<(), VisitError>

impl<T> Visit for Cell<T>where T: Copy + Clone + Visit + 'static,

fn visit(&mut self, name: &str, visitor: &mut Visitor) -> Result<(), VisitError>

impl<T> Visit for RefCell<T>where T: Visit + 'static,

fn visit(&mut self, name: &str, visitor: &mut Visitor) -> Result<(), VisitError>

impl<T> Visit for Range<T>where T: Visit,

fn visit(&mut self, name: &str, visitor: &mut Visitor) -> Result<(), VisitError>

impl<T> Visit for Mutex<T>where T: Visit + Send,

Trait Visit

impl Visit for StreamingBuffer
where GenericBuffer: Visit,

impl Visit for SoundContext
where Option<Arc<Mutex<State>>>: Visit,

impl Visit for Listener
where Matrix<f32, Const<3>, Const<3>, ArrayStorage<f32, 3, 3>>: Visit, Matrix<f32, Const<3>, Const<1>, ArrayStorage<f32, 3, 1>>: Visit,

impl Visit for SoundSource
where String: Visit, Option<Resource<SoundBuffer>>: Visit, f64: Visit, f32: Visit, bool: Visit, Status: Visit, Matrix<f32, Const<3>, Const<1>, ArrayStorage<f32, 3, 1>>: Visit,

impl<K, S> Visit for HashSet<K, S>
where K: Visit + Default + Clone + Hash + Eq, S: BuildHasher + Clone,

impl<K, V, S> Visit for HashMap<K, V, S>
where K: Visit + Default + Clone + Hash + Eq, V: Visit + Default, S: BuildHasher + Clone,

impl<T> Visit for Option<T>
where T: Default + Visit + 'static,

impl<T> Visit for Box<T>
where T: Visit,

impl<T> Visit for Rc<T>
where T: Visit + 'static,

impl<T> Visit for Weak<T>
where T: Default + Visit + 'static,

impl<T> Visit for Arc<T>
where T: Visit + Send + Sync + 'static,

impl<T> Visit for Weak<T>
where T: Default + Visit + Send + Sync + 'static,

impl<T> Visit for Vec<T>
where T: Default + Visit + 'static,

impl<T> Visit for Cell<T>
where T: Copy + Clone + Visit + 'static,

impl<T> Visit for RefCell<T>
where T: Visit + 'static,

impl<T> Visit for Range<T>
where T: Visit,

impl<T> Visit for Mutex<T>
where T: Visit + Send,

impl<T> Visit for RwLock<T>
where T: Visit + Send,

impl<T, const SIZE: usize> Visit for [T; SIZE]
where T: Default + Visit,

impl Visit for ResourceKind
where PathBuf: Visit,

impl Visit for Parameter
where f32: Visit, bool: Visit, u32: Visit, Matrix<f32, Const<2>, Const<1>, ArrayStorage<f32, 2, 1>>: Visit,

impl Visit for PoseWeight
where f32: Visit, String: Visit,

impl Visit for Event
where u64: Visit,

impl Visit for ValueBinding
where ImmutableString: Visit, ValueType: Visit,

impl Visit for EventKind
where MouseButton: Visit, KeyCode: Visit,

impl Visit for Brush
where Color: Visit, Matrix<f32, Const<2>, Const<1>, ArrayStorage<f32, 2, 1>>: Visit, Vec<GradientPoint>: Visit,

impl Visit for TileContentDescriptor
where ImmutableString: Visit, SplitTilesDescriptor: Visit,

impl Visit for TileContent
where Handle<UiNode>: Visit, f32: Visit, [Handle<UiNode>; 2]: Visit,

impl Visit for FileBrowserMode
where PathBuf: Visit,

impl Visit for PropertyEditorInstance
where Handle<UiNode>: Visit,

impl Visit for HotKey
where KeyCode: Visit, KeyboardModifiers: Visit,

impl Visit for KeyBinding
where KeyCode: Visit,

impl Visit for MenuItemContent
where String: Visit, Handle<UiNode>: Visit, bool: Visit,

impl Visit for Force
where [u8; 8]: Visit, Option<[u8; 8]>: Visit,

impl Visit for MouseButton
where u16: Visit,

impl Visit for Placement
where Handle<UiNode>: Visit, Matrix<f32, Const<2>, Const<1>, ArrayStorage<f32, 2, 1>>: Visit,

impl Visit for StyleProperty
where f32: Visit, Thickness: Visit, Color: Visit, Brush: Visit, Resource<Texture>: Visit,

impl Visit for Primitive
where [Matrix<f32, Const<2>, Const<1>, ArrayStorage<f32, 2, 1>>; 3]: Visit, Matrix<f32, Const<2>, Const<1>, ArrayStorage<f32, 2, 1>>: Visit, f32: Visit, usize: Visit, Rect<f32>: Visit,

impl Visit for MaterialResourceBinding
where MaterialTextureBinding: Visit, MaterialPropertyGroup: Visit,

impl Visit for ShaderResourceKind
where SamplerKind: Visit, SamplerFallback: Visit, Vec<ShaderProperty>: Visit,

impl Visit for MaterialSearchOptions
where PathBuf: Visit,

impl Visit for PropertyValue
where Handle<Node>: Visit, ErasedHandle: Visit, String: Visit, i64: Visit, u64: Visit, i32: Visit, u32: Visit, i16: Visit, u16: Visit, i8: Visit, u8: Visit, f32: Visit, f64: Visit,