1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
/*!
Accessor and extension traits for fields.

# Accessor Traits

### For structs and enums

The [FieldType](./trait.FieldType.html) trait,for querying the type of a field,

### For structs

The [GetField](./trait.GetField.html),
[GetFieldMut](./trait.GetFieldMut.html),
[IntoField](./trait.IntoField.html)
accessor traits,that define how a field is accessed.

[IntoFieldMut](./trait.IntoFieldMut.html),a trait alias for `GetFieldMut` + `IntoField`.

### For enums

The [GetVariantField](./trait.GetVariantField.html),
[GetVariantFieldMut](./trait.GetVariantFieldMut.html),
[IntoVariantField](./trait.IntoVariantField.html)
accessor traits,that define how a variant field is accessed.

[IntoVariantFieldMut](./trait.IntoVariantFieldMut.html),
a trait alias for `GetVariantFieldMut` + `IntoVariantField`.

### Destruction traits

These traits allow a type to release resources (ie:memory) when a type is converted into
multiple fields by value:

- [`DropFields`]:
Used to drop the fields that weren't moved out, and run code before they're moved.

- [`PrePostDropFields`]:
Used to add code that runs before and after an automatically generated
[`DropFields`] implementation.

[`DropFields`]: ./ownership/trait.DropFields.html
[`PrePostDropFields`]: ./ownership/trait.PrePostDropFields.html

# Rev* traits

The `Rev*` traits,implemented by field paths,accessing field(s) from the passed-in type.

There are two kinds of `Rev*` traits,single field and multi field traits.

The [StructuralExt](../trait.StructuralExt.html) trait
uses the `Rev*` impls of the passed-in path to access the
fields in `Self`.

### Single Field traits

Which are [RevGetFieldImpl](./rev_get_field/trait.RevGetFieldImpl.html),
[RevGetFieldMutImpl](./rev_get_field/trait.RevGetFieldMutImpl.html),
and [RevIntoFieldImpl](./rev_get_field/trait.RevIntoFieldImpl.html),
mirroring the regular field accessor traits.

The [RevMoveOutFieldImpl](rev_get_field/trait.RevMoveOutFieldImpl.html) trait mirrors the
`Into*Field::move_out_*field_` method.
This is a separate trait because not all single field paths are valid for
moving out a field,they have to refer to a shallow field.

### Multiple field traits

For bounds to access multiple fields at once,
there's [RevGetMultiField],[RevGetMultiFieldMut],and [`RevIntoMultiField`].

For implementing a way to access multiple fields
there's [`RevGetMultiFieldImpl`],[`RevGetMultiFieldMutImpl`],and [`RevIntoMultiFieldImpl`].

There is the [`RevMoveOutMultiFieldImpl`]
trait for moving out multiple shallow fields, useful for implementing [`RevIntoMultiFieldImpl`].

[`RevGetMultiField`]: ./multi_fields/trait.RevGetMultiField.html
[`RevGetMultiFieldMut`]: ./multi_fields/trait.RevGetMultiFieldMut.html
[`RevIntoMultiField`]: ./multi_fields/trait.RevIntoMultiField.html

[`RevGetMultiFieldImpl`]: ./multi_fields/trait.RevGetMultiFieldImpl.html
[`RevGetMultiFieldMutImpl`]: ./multi_fields/trait.RevGetMultiFieldMutImpl.html
[`RevIntoMultiFieldImpl`]: ./multi_fields/trait.RevIntoMultiFieldImpl.html
[`RevMoveOutMultiFieldImpl`]: ./multi_fields/trait.RevMoveOutMultiFieldImpl.html

### type aliases


The [GetFieldType](./type.GetFieldType.html),
[GetFieldType2](./type.GetFieldType2.html),
[GetFieldType3](./type.GetFieldType3.html),
[GetFieldType4](./type.GetFieldType4.html)
type aliases allow querying the type of a field up to 4 levels of nesting.

The [GetVariantFieldType](./type.GetVariantFieldType.html)
for querying the type of an enum variant field,
most useful when the name of the variant and the field are passed separately.

The [RevGetFieldType](./rev_get_field/type.RevGetFieldType.html)
type alias gets the type of a nested field
(which one is determined by the field path).

The [RevFieldErrOut](./rev_get_field/type.RevFieldErrOut.html)
type alias allows querying the `RevGetField::Err` associated type,
useful when delegating the `Rev*Impl` traits.

### Errors

The [errors](./errors/index.html)
module contains the error-related items used in `Rev*` trait impls.

### Normalize Fields

[NormalizeFields](./trait.NormalizeFields.html)
transforms the `Result<T,_>`s from inside a type returned by `Rev` traits into either an
`Option<T>` or a `T` depending on its error type.

[NormalizeFieldsOut](./type.NormalizeFieldsOut.html)
The type that `Foo` is converted into when calling
`Foo::normalize_fields( foo )`.


*/

use crate::{enums::IsVariant, path::VariantField};

use core_extensions::ConstDefault;

use std_::ptr::NonNull;

mod array_impls;
mod enum_impls;
pub mod errors;
mod most_impls;
pub mod multi_fields;
mod normalize_fields;
pub mod ownership;
pub mod rev_get_field;
pub(crate) mod tuple_impls;

// Using this macro instead of modules because compile-time errors print the full path to the
// traits even if the variant_field module is private.
include! {"./field/variant_field.rs"}

pub use self::{
    errors::{
        CombinedErrs, CombinedErrsOut, FailedAccess, InfallibleAccess, IntoFieldErr, IsFieldErr,
    },
    multi_fields::{
        RevGetMultiField, RevGetMultiFieldImpl, RevGetMultiFieldMut, RevGetMultiFieldMutImpl,
        RevGetMultiFieldMutOut, RevGetMultiFieldMutRaw, RevGetMultiFieldOut, RevIntoMultiField,
        RevIntoMultiFieldImpl, RevIntoMultiFieldOut,
    },
    normalize_fields::{NormalizeFields, NormalizeFieldsOut},
    ownership::{DropFields, FieldBit, MovedOutFields, PrePostDropFields},
    rev_get_field::{
        OptRevGetField, OptRevGetFieldMut, OptRevIntoField, OptRevIntoFieldMut, OptRevIntoFieldRef,
        RevFieldErr, RevFieldErrOut, RevFieldType, RevGetField, RevGetFieldImpl, RevGetFieldMut,
        RevGetFieldMutImpl, RevGetFieldType, RevIntoField, RevIntoFieldImpl, RevIntoFieldMut,
        RevIntoFieldRef, RevMoveOutFieldImpl,
    },
};

////////////////////////////////////////////////////////////////////////////////

/// For querying the type of the `FieldPath` field.
///
/// Structs generally implement this with a `TStr` parameter,
/// while enums implement this with a `VariantField` parameter
pub trait FieldType<FieldPath> {
    /// The type of the `FieldPath` field.
    type Ty;
}

////////////////////////////////////////////////////////////////////////////////

/// Provides shared access to the `FieldName` field.
///
/// `FieldName` is expected to be a [TStr](../struct.TStr.html).
///
/// # Safety
///
/// While this trait is not unsafe,
/// implementors ought not mutate fields inside accessor trait impls.
///
/// Mutating fields is only advisable if those fields don't have field accessor impls.
///
/// # Usage as Bound Example
///
/// ```
/// use structural::{StructuralExt,GetField,FP,fp};
///
/// fn example(this:impl GetField<FP!(0), Ty=u32> + GetField<FP!(1), Ty=&'static str>){
///     assert_eq!( this.field_(fp!(0)), &99 );
///     assert_eq!( this.field_(fp!(1)), &"world" );
///
///     assert_eq!( this.fields(fp!(0,1)), (&99, &"world") );
///     assert_eq!( this.cloned_fields(fp!(0,1)), (99, "world") );
/// }
///
/// example((99,"world",));
/// example((99,"world",100,101,102,));
///
/// ```
///
/// # Manual Implementation Example
///
/// While this trait is intended to be implemented using the `Structural` derive macro,
/// you can manually implement it like this:
///
/// ```rust
/// use structural::{FieldType,GetField,Structural,FP};
///
/// struct Huh<T>{
///     value:T,
/// }
///
/// impl<T> Structural for Huh<T>{}
///
///
/// impl<T> FieldType<FP!(value)> for Huh<T>{
///     type Ty=T;
/// }
///
/// impl<T> GetField<FP!(value)> for Huh<T>{
///     fn get_field_(&self,_:FP!(value))->&Self::Ty{
///         &self.value
///     }
/// }
///
/// ```
///
pub trait GetField<FieldName>: FieldType<FieldName> {
    /// Accesses the `FieldName` field by reference.
    fn get_field_(&self, field_name: FieldName) -> &Self::Ty;
}

/// Queries the type of a field.
///
/// # Example
///
/// Here is one way you can get the type of a `struct` field.
///
// These attributes are a workaround for const generics being broken.
//
// When const generics are enabled,
// there's some lifetime bound errors that can't be worked around.
#[cfg_attr(not(feature = "use_const_str"), doc = "```rust")]
#[cfg_attr(feature = "use_const_str", doc = "```ignore")]
/// use structural::{GetField,StructuralExt,GetFieldType,FP,fp};
///
/// fn get_name<'a,T>(this:&'a T)->&'a GetFieldType<T,FP!(name)>
/// where
///     T:GetField<FP!(name)>,
/// {
///     this.field_(fp!(name))
/// }
///
///
/// #[derive(structural::Structural)]
/// struct Huh<T>{
///     #[struc(public)]
///     #[struc(rename="name")]
///     value:T,
/// }
///
/// fn main(){
///     let this=Huh{ value:"ooh".to_string() };
///     
///     assert_eq!( get_name(&this), "ooh" );
/// }
/// ```
///
/// Another way `get_name` could have been written is like this:
///
/// ```
/// use structural::{GetField,StructuralExt,GetFieldType,FP,fp};
///
/// fn get_name<T,O>(this:&T)->&O
/// where
///     T:GetField<FP!(name), Ty=O>
/// {
///     this.field_(fp!(name))
/// }
/// ```
/// A potential downside of adding another type parameter is that it
/// makes it less ergonomic to specify the type of `T` while ignoring the field type,
/// since one has to write it as `get_name::<Foo,_>(&foo)`.
///
/// # Example
///
/// Here's an example of accessing an `enum` field,using `GetFieldType` to get the field type.
///
/// This also demonstrates a way to write extension traits.
///
// These attributes are a workaround for const generics being broken.
//
// When const generics are enabled,
// there's some lifetime bound errors that can't be worked around.
#[cfg_attr(not(feature = "use_const_str"), doc = "```rust")]
#[cfg_attr(feature = "use_const_str", doc = "```ignore")]
/// use structural::{FP, StructuralExt, GetFieldType, GetVariantField, Structural, TS, fp};
/// use structural::for_examples::EnumOptA;
///
/// let foo= EnumOptA::Limbs{legs:Some(9), hands:None};
/// assert_eq!( foo.get_limbs(), Some((&Some(9), &None)) );
///
/// let array=[0,1,2,3];
/// let baz=EnumGround::Limbs{legs:"many", hands:&array};
/// assert_eq!( baz.get_limbs(), Some((&"many", &&array[..])) );
///
/// trait GetLimbs:
///     GetVariantField<TS!(Limbs),TS!(legs)> +
///     GetVariantField<TS!(Limbs),TS!(hands)>
/// {
///     fn get_limbs(&self)-> Option<(
///         &GetFieldType<Self, FP!(::Limbs.legs)>,
///         &GetFieldType<Self, FP!(::Limbs.hands)>,
///     )> {
///         self.fields(fp!(::Limbs=>legs,hands))
///     }
/// }
///
/// impl<T> GetLimbs for T
/// where
///     T: ?Sized +
///        GetVariantField<TS!(Limbs),TS!(legs)> +
///        GetVariantField<TS!(Limbs),TS!(hands)>
/// {}
///
///
/// #[derive(Structural, Copy, Clone, Debug, PartialEq)]
/// #[struc(no_trait)]
/// pub enum EnumGround<'a> {
///     Limbs {
///         legs: &'static str,
///         hands: &'a [u8],
///     },
/// }
///
/// ```
pub type GetFieldType<This, FieldPath> = <This as FieldType<FieldPath>>::Ty;

/// Queries the type of a double nested field (eg:`.a.b`).
///
/// Example usage:
/// `GetFieldType2<T,FP!(foo),FP!(bar)>`
pub type GetFieldType2<This, FieldPath, FieldPath2> =
    GetFieldType<GetFieldType<This, FieldPath>, FieldPath2>;

/// Queries the type of a triple nested field (eg:`.a.b.c`).
///
/// Example usage:
/// `GetFieldType3<T,FP!(foo),FP!(bar),FP!(baz)>`
pub type GetFieldType3<This, FieldPath, FieldPath2, FieldPath3> =
    GetFieldType<GetFieldType2<This, FieldPath, FieldPath2>, FieldPath3>;

/// Queries the type of a quadruple nested field (eg:`.a.b.c.d`).
///
/// Example usage:
/// `GetFieldType4<T,FP!(foo),FP!(bar),FP!(baz),FP!(boom)>`
pub type GetFieldType4<This, FieldPath, FieldPath2, FieldPath3, FieldPath4> =
    GetFieldType2<GetFieldType2<This, FieldPath, FieldPath2>, FieldPath3, FieldPath4>;

/// Allows accessing the `FieldName` field mutably.
///
/// # Safety
///
/// These are requirements for manual implementations.
///
/// Implementors ought not mutate fields inside their accessor trait impls,
/// or the accessor trait impls of other fields.
///
/// It is recommended that you use the `z_unsafe_impl_get_field_raw_mut` macro
/// if you only borrow a field of the type.
///
/// ### Implementing `get_field_raw_mut`
///
/// Your implementation of `GetFieldMut::get_field_raw_mut` must ensure these properties:
/// <span id="raw_mut_properties"></span>
///
/// - It must be side-effect free,
///
/// - The method must return a pointer to a fully initialized field,
///
/// - The field you access must always be the same one.
///
/// - That no implementation returns a pointer to a field that (other) implementations
/// for the same type also return,
///
/// - That no implementation returns a pointer to a field that (other)
/// `GetVariantFieldMut` implementations for the same type also return,
///
/// You can unerase the pointer by casting it to `*mut Self`
/// (you can also use any type that's compatible with `Self`).
///
/// Your implementation of the `get_field_raw_mut_fn` method must only return a
/// function pointer to a function that ensures the properties listed
/// [above](#raw_mut_properties).
///
///
/// # Example: Usage as Bound
///
/// ```
/// use structural::{StructuralExt,GetFieldMut,FP,fp};
/// use structural::for_examples::{Struct2,Struct3};
///
/// fn example<T>(this:&mut T)
/// where
///     T: GetFieldMut<FP!(foo), Ty=Option<u32>> + GetFieldMut<FP!(bar), Ty=&'static str>
/// {
///     assert_eq!( this.field_(fp!(foo)), &Some(21) );
///     assert_eq!( this.field_(fp!(bar)), &"oh boy" );
///     assert_eq!( this.fields(fp!(foo,bar)), (&Some(21), &"oh boy") );
///     assert_eq!( this.cloned_fields(fp!(foo,bar)), (Some(21), "oh boy") );
///
///     assert_eq!( this.field_mut(fp!(foo)), &mut Some(21) );
///     assert_eq!( this.field_mut(fp!(bar)), &mut "oh boy" );
///     assert_eq!( this.fields_mut(fp!(foo,bar)), (&mut Some(21), &mut "oh boy") );
/// }
///
/// example(&mut Struct2{ foo:Some(21), bar: "oh boy" });
/// example(&mut Struct3{ foo:Some(21), bar: "oh boy", baz:5 });
///
/// ```
///
/// <span id="manual-implementation-example"></span>
/// # Example: Manual implementation
///
/// While this trait is intended to be implemented using the `Structural` derive macro,
/// you can also implement it like this:
///
/// ```rust
/// use structural::{FieldType,GetField,GetFieldMut,Structural,FP};
///
/// struct Huh<T>{
///     value:T,
/// }
///
/// impl<T> Structural for Huh<T>{}
///
/// impl<T> FieldType<FP!(value)> for Huh<T>{
///     type Ty=T;
/// }
///
/// impl<T> GetField<FP!(value)> for Huh<T>{
///     fn get_field_(&self,_:FP!(value))->&Self::Ty{
///         &self.value
///     }
/// }
///
/// unsafe impl<T> GetFieldMut<FP!(value)> for Huh<T>{
///     fn get_field_mut_(&mut self,_:FP!(value))->&mut Self::Ty{
///         &mut self.value
///     }
///     structural::z_unsafe_impl_get_field_raw_mut!{
///         Self,
///         field_tstr=value,
///         name_generic=FP!(value),
///     }
/// }
///
/// ```
///
pub unsafe trait GetFieldMut<FieldName>: GetField<FieldName> {
    /// Accesses the `FieldName` field by mutable reference.
    fn get_field_mut_(&mut self, field_name: FieldName) -> &mut Self::Ty;

    /// Gets a mutable pointer for the field.
    ///
    /// # Safety
    ///
    /// You must pass a pointer casted from `*mut  Self` to `*mut  ()`,
    /// pointing to a fully initialized instance of the type.
    unsafe fn get_field_raw_mut(ptr: *mut (), field_name: FieldName) -> *mut Self::Ty
    where
        Self: Sized;

    /// Gets the `get_field_raw_mut` associated function as a function pointer.
    fn get_field_raw_mut_fn(&self) -> GetFieldRawMutFn<FieldName, Self::Ty>;
}

/// A `GetFieldMut` specifically used for specialization internally.
///
/// Moving the specialization to a separate impl somehow improves the error messages
/// when calling `StructuralExt::{field_mut,fields_mut}` methods.
///
/// # Safety
///
/// This trait has the same safety requirements as `GetFieldMut`.
#[doc(hidden)]
pub unsafe trait SpecGetFieldMut<FieldName>: GetField<FieldName> {
    /// Gets a mutable pointer for the field.
    ///
    /// # Safety
    ///
    /// You must pass a pointer casted from `*mut  Self` to `*mut  ()`,
    /// pointing to a fully initialized instance of the type.
    unsafe fn get_field_raw_mut_inner(ptr: *mut (), field_name: FieldName) -> *mut Self::Ty
    where
        Self: Sized;
}

/////////////////////////////////////////////////

/// The type of `GetFieldMut::get_field_raw_mut`
pub type GetFieldRawMutFn<FieldName, FieldTy> = unsafe fn(*mut (), FieldName) -> *mut FieldTy;

/////////////////////////////////////////////////

/// Converts this type into its `FieldName` field by value.
///
/// # Safety
///
/// ### Implementing `move_out_field_`
///
/// The way this method is expected to be implemented is like this:
///
/// - Move out the field using `std::ptr::read` or equivalent.
///
/// - Mark the field in the `moved_fields` parameter as being moved out using the
/// `set_moved_out` method,
/// with a `FieldBit` argument unique to this field in this type
/// (fields from different types can use the same `FieldBit` as fields in other types).
///
/// Every implementation of `IntoField::move_out_field_`
/// must return field(s) that no other implementation of
/// `IntoVariantField` or `IntoField` for this type return.
///
/// The `DropFields::drop_fields` implementation for this type must then
/// call `is_moved_out` on its `MovedOutFields` parameter
/// to decide whether to drop the field,
/// passing the same `FieldBit` argument as in the `move_out_field_` implementation.
/// If `is_moved_out` returns false, then the field must be dropped.
///
/// # Usage as Bound Example
///
/// ```
/// use structural::{StructuralExt,IntoField,FP,fp};
/// use structural::for_examples::{Struct2,Struct3};
///
/// fn example<T>(this: T)
/// where
///     T: IntoField<FP!(foo), Ty=Option<i8>> + IntoField<FP!(bar), Ty=&'static str>
/// {
///     assert_eq!( this.field_(fp!(foo)), &None );
///     assert_eq!( this.field_(fp!(bar)), &"great" );
///     assert_eq!( this.fields(fp!(foo,bar)), (&None, &"great") );
///     assert_eq!( this.cloned_fields(fp!(foo,bar)), (None, "great") );
///
///     // This can't be called with `IntoField` you need `IntoFieldMut` for that.
///     // assert_eq!( this.field_mut(fp!(bar)), &mut "great" );
///
///     assert_eq!( this.into_fields(fp!(foo, bar)), (None, "great") );
/// }
///
/// example(Struct2{ foo:None, bar: "great" });
/// example(Struct3{ foo:None, bar: "great", baz:5 });
///
/// ```
///
/// <span id="manual-impl-example"></span>
/// # Manual Implementation Example
///
/// While this trait is intended to be implemented using the `Structural` derive macro,
/// you can manually implement it like this:
///
/// ```rust
/// use structural::{FieldType,GetField,IntoField,Structural,FP};
/// use structural::field::ownership::{DropFields, MovedOutFields, RunDrop, FieldBit};
///
/// struct Huh<T>{
///     first:T,
///     second:T,
/// }
///
///
/// impl<T> Structural for Huh<T>{}
///
///
/// impl<T> FieldType<FP!(first)> for Huh<T>{
///     type Ty=T;
/// }
///
/// impl<T> GetField<FP!(first)> for Huh<T>{
///     fn get_field_(&self, _: FP!(first))->&Self::Ty{
///         &self.first
///     }
/// }
///
/// const FIRST_INDEX: FieldBit = FieldBit::new(0);
///
/// unsafe impl<T> IntoField<FP!(first)> for Huh<T>{
///     fn into_field_(self, _: FP!(first))->Self::Ty{
///         self.first
///     }
///
///     unsafe fn move_out_field_(
///         &mut self,
///         field_name: FP!(first),
///         moved_fields: &mut MovedOutFields,
///     ) -> Self::Ty {
///         moved_fields.set_moved_out(FIRST_INDEX);
///         std::ptr::read(&mut self.first)
///     }
/// }
///
///
/// impl<T> FieldType<FP!(second)> for Huh<T>{
///     type Ty=T;
/// }
///
/// impl<T> GetField<FP!(second)> for Huh<T>{
///     fn get_field_(&self, _: FP!(second))->&Self::Ty{
///         &self.second
///     }
/// }
///
/// const SECOND_INDEX: FieldBit = FieldBit::new(1);
///
/// unsafe impl<T> IntoField<FP!(second)> for Huh<T>{
///     fn into_field_(self, _: FP!(second))->Self::Ty{
///         self.second
///     }
///
///     unsafe fn move_out_field_(
///         &mut self,
///         field_name: FP!(second),
///         moved_fields: &mut MovedOutFields,
///     ) -> Self::Ty {
///         moved_fields.set_moved_out(SECOND_INDEX);
///         std::ptr::read(&mut self.second)
///     }
/// }
///
///
/// unsafe impl<T> DropFields for Huh<T>{
///     // This type does nothing before fields are moved.
///     fn pre_move(&mut self){}
///
///     unsafe fn drop_fields(&mut self, moved: MovedOutFields){
///         let Self{first, second} = self;
///
///         // RunDrop here ensures that the destructors for all fields are ran
///         // even if any of them panics.
///         let _drop;
///         if moved.is_moved_out(FIRST_INDEX) {
///             _drop = unsafe{ RunDrop::new(first) };
///         }
///         let _drop;
///         if moved.is_moved_out(SECOND_INDEX) {
///             _drop = unsafe{ RunDrop::new(second) };
///         }
///     }
/// }
///
/// ```
///
pub unsafe trait IntoField<FieldName>: GetField<FieldName> + DropFields {
    /// Converts this into the field by value.
    fn into_field_(self, field_name: FieldName) -> Self::Ty;

    /// Moves out the field from self.
    ///
    /// # Safety
    ///
    /// The same instance of `MovedOutFields` must be passed to every call to
    /// `move_out_field_` on the same instance of this type,
    /// as well as not mutating that `MovedOutFields` instance outside of
    /// methods of this trait for this type.
    ///
    /// Each field must be moved at most once on the same instance of this type.
    unsafe fn move_out_field_(
        &mut self,
        field_name: FieldName,
        moved_fields: &mut MovedOutFields,
    ) -> Self::Ty;
}

/// A bound for shared, mutable,and by-value access to the `FieldName` field.
///
/// This is only usable as a bound,
/// to access the field you can use any [StructuralExt](../trait.StructuralExt.html) method.
///
/// # Example
///
/// This particular example only works with the "alloc" feature enabled
/// (it's enabled by default),because it uses `Box`.
///
#[cfg_attr(not(feature = "alloc"), doc = "```ignore")]
#[cfg_attr(feature = "alloc", doc = "```rust")]
/// use structural::{StructuralExt,IntoFieldMut,FP,fp};
/// use structural::for_examples::{Struct2,Struct3};
///
/// fn example(mut this:Box<dyn Bounds>){
///     assert_eq!( this.field_(fp!(foo)), &Some(false) );
///     assert_eq!( this.field_(fp!(bar)), &"oh boy" );
///
///     assert_eq!( this.fields(fp!(foo,bar)), (&Some(false), &"oh boy") );
///
///     assert_eq!( this.cloned_fields(fp!(foo,bar)), (Some(false), "oh boy") );
///
///     assert_eq!( this.field_mut(fp!(foo)), &mut Some(false) );
///     assert_eq!( this.field_mut(fp!(bar)), &mut "oh boy" );
///
///     assert_eq!( this.fields_mut(fp!(foo,bar)), (&mut Some(false), &mut "oh boy") );
///
///     assert_eq!( this.into_fields(fp!(foo, bar)), (Some(false), "oh boy") );
/// }
///
/// example(Box::new(Struct2{ foo:Some(false), bar: "oh boy" }));
/// example(Box::new(Struct3{ foo:Some(false), bar: "oh boy", baz:5 }));
///
///
/// // This trait and impl block is what the `structural_alias` macro expands to.
/// trait Bounds:
///     IntoFieldMut<FP!(foo), Ty=Option<bool>> +
///     IntoFieldMut<FP!(bar), Ty=&'static str>
/// {}
///
/// impl<This> Bounds for This
/// where
///     This:?Sized +
///         IntoFieldMut<FP!(foo), Ty=Option<bool>> +
///         IntoFieldMut<FP!(bar), Ty=&'static str>
/// {}
///
/// ```
pub trait IntoFieldMut<F>: IntoField<F> + GetFieldMut<F> {}

impl<This, F> IntoFieldMut<F> for This where This: ?Sized + IntoField<F> + GetFieldMut<F> {}