Merging 'optional_getters' branch for the 0.3 release

.gitignore

@@ -1,3 +1,6 @@
 /target
 **/*.rs.bk
 Cargo.lock
+structural_crates.7z
+structural_crates.zip
+*script.sh

.travis.yml

@@ -21,23 +21,19 @@ matrix:
         - rustup component add miri
         - cargo miri setup
 
-        - cargo test --no-default-features --features testing --features nightly_specialization
-        - cargo test --no-default-features --features testing --features alloc --features nightly_specialization
-        - cargo test --no-default-features --features testing --features std nightly_specialization
+        - cargo test --no-default-features --features testing --features       nightly_specialization
+        - cargo test --no-default-features --features testing --features alloc nightly_specialization
+        - cargo test --no-default-features --features testing --features std   nightly_specialization
 
-        - cargo test --no-default-features --features testing --features nightly_better_macros
-        - cargo test --no-default-features --features testing --features alloc --features nightly_better_macros
-        - cargo test --no-default-features --features testing --features std nightly_better_macros
+        - cargo test --no-default-features --features testing --features       nightly_use_const_str
+        - cargo test --no-default-features --features testing --features alloc nightly_use_const_str
+        - cargo test --no-default-features --features testing --features std   nightly_use_const_str
 
-        - cargo test --no-default-features --features testing --features better_macros
-        - cargo test --no-default-features --features testing --features alloc --features better_macros
-        - cargo test --no-default-features --features testing --features std better_macros
+        - cargo test --no-default-features --features testing --features       nightly_impl_fields
+        - cargo test --no-default-features --features testing --features alloc nightly_impl_fields
+        - cargo test --no-default-features --features testing --features std   nightly_impl_fields
 
-        - cargo test --no-default-features --features testing --features nightly_impl_fields
-        - cargo test --no-default-features --features testing --features alloc --features nightly_impl_fields
-        - cargo test --no-default-features --features testing --features std nightly_impl_fields
-
-        - cargo test --all-features
+        - cargo test --features test_all
 
         - cargo clean
 
@@ -46,9 +42,9 @@ matrix:
         - cargo miri test --no-default-features --features testing --features nightly_specialization
         - cargo miri test --no-default-features --features testing --features alloc --features nightly_specialization
         - cargo miri test --no-default-features --features testing --features std --features nightly_specialization
-        - cargo miri test --all-features
+        - cargo miri test --features test_all
 
-    - rust: 1.34.0
+    - rust: 1.40.0
 
 script:
 

Changelog.md

@@ -1,12 +1,231 @@
 This is the changelog,summarising changes in each version(some minor changes may be ommited).
 
-### 0.2.2
+# 0.3.0
+
+Added support for enums,
+defining the `GetVariantField` `GetVariantFieldMut` `IntoVariantField` traist for enums,
+the `IntoVariantFieldMut` trait alias, and `GetVariantFieldType` type alias.
+
+Moved the `GetField::Ty` to the newly created `FieldType` trait,
+supertrait of both `GetField` and `GetVariantField`.
+
+Changed output of single "path component" (non nested field/variant/variant field access)
+`fp` or `FP` macro invocation from `FieldPath<(S,)>` to `S`.
+
+Renamed `GetFieldExt` trait to `StructuralExt`.
+
+Renamed `FieldPath` to `NestedFieldPath`,since they are always for nested fields.
+
+Added the `StrucWrapper` wrapper type,
+which defines inherent method equivalents of all `StructuralExt` methods,
+with shorter method names.
+
+Moved `type_level::field_path` to the root module and renamed it to `path`,
+moved the `TStr`,`NestedFieldPath`,`FieldPathSet`
+to the root module for error messages to be shorter.
+
+Moved field accessor traits to the `structural::field` module.
+
+Declared these structs in the root module:
+- `VariantName` (what `FP!(::Variant)` desugars to),for accessing an enum variant.
+- `VariantField` (what `FP!(::Variant.field)` desugars to),for accessing a variant field.
+- `NestedFieldPathSet` (what `FP!(foo=>bar,baz)` desugars to),
+for accessing multiple fields from inside a nested field/variant.
+
+Made string literals/integers/identifiers usable as varianble and field names
+in the field path macros,
+using the string literals to implement *arbitrary identifiers*.
+
+Added `?` syntactic sugar for field path macros,to get the value of an option field.
+`?` is sugar because it's transformed into `::Some.0` as soon as it's parsed.
+
+Fixed a few parsing errors in field path macros due to `0.1` being tokenized
+as a float literal
+(tricky in combination with the rest of the syntax that those macros support)
+
+Changed representation of `NestedFieldPath`,`FieldPathSet` to store their tuple type parameter 
+as a field (the same for `VariantName`,`VariantField`,`NestedFieldPathSet`),
+constructible from their fields by value
+(some with a constructor,some with the struct literal).<br>
+Also changed how `FieldPathSet`/`NestedFieldPathSet` with a `UniquePaths` are 
+constructed to using `Type::NEW.upgrade_unchecked()`.
+
+Replaced all `core_extensions::MarkerType` impls with `core_extensions::ConstDefault`
+to allow field paths to be constructed from non-zero-sized types.
+
+Defining these trait to the generated code for enums:
+
+- `*_SI`: Which aliases accessor trait impls of the enum.
+
+- `*_ESI`: similar to the `*_SI` with the additional requirement that the 
+variant count and names must match exactly.
+
+- `*_VC`(opt-in): The amount of variants in the enum as a decimal `TStr`.
+
+Added `*_VSI` trait to the generated code for structs,
+to use it as the bound for an enum variant with compatible fields.
+
+Changed the `field_path_aliases` macro to also accept a module as an argument,
+removing `field_path_aliases_module`.
+
+Exposing the `TStr` type-level string type publically.
+Using `TS` to get the type(in a type context),and `ts` to construct it.
+
+Defined the `tstr_aliases` macro,similar to `field_path_aliases` but for 
+`TStr`(the type-level string type).
+
+Defined the `VariantProxy` type to access variant fields directly.
+
+Defined the `EnumExt` trait to construct `VariantProxy` fallibly.
+
+Defined the `IsVariant` trait to query whether the current variant is a particular one,
+adding `StructuralExt::is_variant` that delegates to this for convenience.
+
+Defined the `VariantCount` trait to get the amount of variants as a decimal `TStr`,
+eg: `TS!(9)`,`TS!(17)`,etc.
+
+Defined the `switch` macro,to match on structural enums,either exhaustive or nonexhaustive.
+
+Updated `structural_alias` macro to also support enums,and defaulted constants/functions.
+
+Added these attributes to structural aliases(usable on each trait):
+
+- `#[struc(debug_print)]`:
+Panics at compile-time,printing the what structural_alias outputs for the trait.
+
+- `#[struc(exhaustive_enum)]`: marks the structural alias as being for an exhaustive enum.
+
+- `#[struc(and_exhaustive_enum)]`:
+Creates a subtrait of this structural alias for an exhaustive versioned of the aliased enum.
+
+
+Added `impl_struct` macro to get an `impl Trait` for a structural struct type,
+with permutations of the `GetField` `GetFieldMut` `IntoField` `IntoFieldMut` traits.
+
+Defined example types used in documentation examples in `for_examples`.
+
+Removed the type metadata in `Structural` trait,
+and removed `StructuralDyn` because it interacted badly with enums.
+
+Added generated documentation for public items,and Structural trait impls.
+
+Added these attributes to the `Structural` derive:
+
+- `#[struc(bound="T:Trait")]`: to add bounds to the generated impls
+
+- `#[struc(replace_bounds="Trait<@variant>")]` attribute for enum variants,
+to replace the bound for the fields of the enum variant with the ones passed to the attribute.
+`@variant` arguments are replaced with `TS!( Foo )`,
+where Foo is the name of the variant that the attribute was used on.
+
+- `#[struc(newtype)]` attribute for newtype enum variants,
+delegating field accessors to the wrapped type.
+This attribute has an optional argument to do what `#[struc(replace_bounds)]` does.
+
+- `#[struc(variant_count_alias)]` attribute for enums,
+that outputs `*_VC` (a type alias with the amount of variants in the enum as a decimal `TStr` )
+along with the rest of the rest of the generated code.
+
+- `#[struc(no_docs)]`: disables the docs in generated code.
+
+- `#[non_exhaustive]`: 
+This built-in `#[non_exhaustive]` attribute marks an enum as having non-exhaustive variants,
+changing the generated code to not rely on the amount of variants of the enum,
+and disallowing exhaustive matching with the `switch` macro.
+
+
+Changed these attributes:
+
+- `#[struc(delegate_to)` now accepts optional arguments for 
+additional bounds on the accessor trait impls.
+
+- `#[struc(rename="foo")`  is now also usable on variants.
+
+
+Renamed the delegation macro to `unsafe_delegate_structural_with`,updated it to handle enums,
+added the `specialization_params` parameter to specify how specialization of 
+the raw pointer accessor method works.
+
+Added impls of accessor traits for:
+
+- arrays up to 32 elements.
+
+- Option:with regular Some and None variants
+
+- Result:with regular Ok and Err variants (eg:using `fp!(::Ok.0)` to access `T`)
+
+Added structural aliases for arrays and tuples (up to the implemented sizes).
+
+Improved the docs for virtually everything,
+including by having examples for enums in everything that's for both enums and structs.
+
+Replaced `IsFieldPath` and `IsFieldPathSet` with `IsSingleFieldPath` `IsMultiFieldPath`,
+implementing them for all the types that implement the corresponding `Rev*` traits,
+making their supertraits just `Sized`.
+
+Changed `StructuralExt` to accept any argument implementing the appropriate `Rev*` trait,
+where before it would only `*Path*` types defined in the `structural` crate.
+
+Added back the what used to be the `GetMultiField` traits as the 
+`RevGetMultiFieldImpl` and `RevGetMultiFieldMutImpl` traits.<br>
+Defined `RevGetMultiField` and `RevGetMultiField`extension traits that
+transform the `Result<_,_>` returned by `Rev*MultiField*Impl` traits
+into `T` or `Option<T>` depending on the error type.
+
+Removed MutRef entirely,replacing all its uses with raw pointers.
+
+Removed the `RevIntoFieldImpl::rev_box_into_field` method
+
+Renamed `RevGetField`/`RevGetFieldMut`/`RevIntoField` to
+`RevGetFieldImpl`/`RevGetFieldMutImpl`/`RevIntoFieldImpl`,
+and changed them to return a single field,<br>
+Made `RevGetFieldImpl` a supertrait of both `RevGetFieldMutImpl` and `RevIntoFieldImpl`,
+with RevGetFieldMut as an unsafe trait.<br>
+Those traits also have trait aliases,
+named [Opt]RevGetField/[Opt]RevGetFieldMut/[Opt]RevIntoField/[Opt]RevIntoFieldMut.
+
+Defined `use_const_str` and `nightly_use_const_str` features to use const generics as an
+implementation detail of `TStr`.
+Also defined the `disable_const_str` feature to disable const generics if there's 
+a bug in the compiler,and other libraries also use them.
+
+Removed the `FieldPath1` type alias.
+
+Removed `From` impls for field paths.
+
+Removed the `utils::coerce_slice` function.
+
+Added `NormalizeFields` trait,
+for returning both optional and non-optional fields from `StructuralExt`,
+
+Added `IsFieldErr` marker trait for the valid error types (`FailedAccess` and `InfallibleAccess`),
+and the `CombinedErrs` trait to get the optionality of a nested field.
+
+Defined the `z_raw_borrow_enum_field` macro,for raw borrowing of enums.
+
+Defined the `z_unsafe_impl_get_vfield_raw_mut_fn` macro,
+to implement function-pointer-getter methods.
+
+Defined the `IntoAliasing` trait and `IntoAliasingOut` type alias,
+to get a field path set type which can only be used to get shared access to multiple fields.
+
+
+Dependencies:
+
+- Bumped the minimum supported Rust version to 1.40,
+so that proc macros in type position could be used in examples.
+
+- Added `generational_arena` depedency to `structural_derive` crate.
+
+- Bumped `core_extensions` dependency to `0.1.15` for `structural` crate.
+
+# 0.2.2
 
 Added `GetFieldExt::cloned_fields` method.
 
 Fixed support of alloc crate.
 
-### 0.2.0
+# 0.2.0
 
 Replaced field identifiers with field paths,
 which can represent both nested fields `.a.b.c`(with the FieldPath type),
@@ -77,7 +296,7 @@ Changes to `z_delegate_structural_with`:
 
     - Renamed `field_ty` argument to `delegating_to_type`
 
-    - Added `field_name_param=( field_name : FieldName );` argument.
+    - Added `field_name_param=( field_name : FieldPath );` argument.
 
     - Added `as_delegating_raw{ ..... }` argument,
       to get a raw pointer to the delegated to variable.
@@ -99,12 +318,12 @@ Added traits and types for manipulating field paths on the type-level,
 inside of `structural::type_level::collection_traits`.
 
 
-### 0.1.0
+# 0.1.0
 
 Declared per-field accessor traits (GetField/GetFieldMut/intoField/IntoFieldMut) and 
 implemented them for standard library types.
 
-Declared extension trait GetFieldExt that uses the accessor traits,
+Declared extension trait `GetFieldExt` that uses the accessor traits,
 this is the intended way to call field accessor methods.
 
 Declared `Structural` derive macro,
@@ -113,7 +332,7 @@ to implement the accessor traits for the fields of structs.
 Declared `Structural` and `StructuralDyn` traits to describe the fields that a type has.
 
 Declared the `ti` macro to 
-instantiate field name(s) to use as a parameter to GetFieldExt methods.
+instantiate field name(s) to use as a parameter to `GetFieldExt` methods.
 
 Declared the `TI` macro to pass a field name as a generic parameter.
 

commit.sh

@@ -0,0 +1,20 @@
+#!/bin/sh
+
+#
+# You can use this script to format and commit the code all at once
+#
+#
+
+cargo fmt
+
+if [ $? -eq 0 ]
+then
+    echo "ran cargo fmt!!!!"
+else
+    exit 1
+fi
+
+
+git update-index --again
+
+git commit