diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-19 00:47:55 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-19 00:47:55 +0000 |
commit | 26a029d407be480d791972afb5975cf62c9360a6 (patch) | |
tree | f435a8308119effd964b339f76abb83a57c29483 /third_party/rust/derive_more-impl/doc/as_mut.md | |
parent | Initial commit. (diff) | |
download | firefox-26a029d407be480d791972afb5975cf62c9360a6.tar.xz firefox-26a029d407be480d791972afb5975cf62c9360a6.zip |
Adding upstream version 124.0.1.upstream/124.0.1
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'third_party/rust/derive_more-impl/doc/as_mut.md')
-rw-r--r-- | third_party/rust/derive_more-impl/doc/as_mut.md | 129 |
1 files changed, 129 insertions, 0 deletions
diff --git a/third_party/rust/derive_more-impl/doc/as_mut.md b/third_party/rust/derive_more-impl/doc/as_mut.md new file mode 100644 index 0000000000..a1e6127d3a --- /dev/null +++ b/third_party/rust/derive_more-impl/doc/as_mut.md @@ -0,0 +1,129 @@ +# What `#[derive(AsMut)]` generates + +Deriving `AsMut` generates one or more implementations of `AsMut`, each +corresponding to one of the fields of the decorated type. +This allows types which contain some `T` to be passed anywhere that an +`AsMut<T>` is accepted. + + + + +## Newtypes and Structs with One Field + +When `AsMut` is derived for a newtype or struct with one field, a single +implementation is generated to expose the underlying field. + +```rust +# use derive_more::AsMut; +# +#[derive(AsMut)] +struct MyWrapper(String); +``` + +Generates: + +```rust +# struct MyWrapper(String); +impl AsMut<String> for MyWrapper { + fn as_mut(&mut self) -> &mut String { + &mut self.0 + } +} +``` + +It's also possible to use the `#[as_mut(forward)]` attribute to forward +to the `as_mut` implementation of the field. So here `SingleFieldForward` +implements all `AsMut` for all types that `Vec<i32>` implements `AsMut` for. + +```rust +# use derive_more::AsMut; +# +#[derive(AsMut)] +#[as_mut(forward)] +struct SingleFieldForward(Vec<i32>); + +let mut item = SingleFieldForward(vec![]); +let _: &mut [i32] = (&mut item).as_mut(); +``` + +This generates: + +```rust +# struct SingleFieldForward(Vec<i32>); +impl<__AsMutT: ?::core::marker::Sized> ::core::convert::AsMut<__AsMutT> for SingleFieldForward +where + Vec<i32>: ::core::convert::AsMut<__AsMutT>, +{ + #[inline] + fn as_mut(&mut self) -> &mut __AsMutT { + <Vec<i32> as ::core::convert::AsMut<__AsMutT>>::as_mut(&mut self.0) + } +} +``` + + + + +## Structs with Multiple Fields + +When `AsMut` is derived for a struct with more than one field (including tuple +structs), you must also mark one or more fields with the `#[as_mut]` attribute. +An implementation will be generated for each indicated field. +You can also exclude a specific field by using `#[as_mut(ignore)]`. + +```rust +# use derive_more::AsMut; +# +#[derive(AsMut)] +struct MyWrapper { + #[as_mut] + name: String, + #[as_mut] + num: i32, + valid: bool, +} +``` + +Generates: + +```rust +# struct MyWrapper { +# name: String, +# num: i32, +# valid: bool, +# } +impl AsMut<String> for MyWrapper { + fn as_mut(&mut self) -> &mut String { + &mut self.name + } +} + +impl AsMut<i32> for MyWrapper { + fn as_mut(&mut self) -> &mut i32 { + &mut self.num + } +} +``` + +Note that `AsMut<T>` may only be implemented once for any given type `T`. This means any attempt to +mark more than one field of the same type with `#[as_mut]` will result in a compilation error. + +```rust,compile_fail +# use derive_more::AsMut; +# +// Error! Conflicting implementations of AsMut<String> +#[derive(AsMut)] +struct MyWrapper { + #[as_mut] + str1: String, + #[as_mut] + str2: String, +} +``` + + + + +## Enums + +Deriving `AsMut` for enums is not supported. |