Add builder methods and move NvPublic

This commit brings two changes:
* implementing `builder` methods on all types that have their own
`...Builder` type, so that users are more easily directed to them in the
documentation.
* moving the `nv` top-level module within the `structures` module to
make things a bit more consistent.

Signed-off-by: Ionut Mihalcea <[email protected]>

Author: ionut-arm

tss-esapi/src/abstraction/nv.rs

@@ -7,8 +7,7 @@ use crate::{
     constants::{tss::*, CapabilityType, PropertyTag},
     handles::{NvIndexHandle, NvIndexTpmHandle, TpmHandle},
     interface_types::resource_handles::NvAuth,
-    nv::storage::NvPublic,
-    structures::{CapabilityData, Name},
+    structures::{CapabilityData, Name, NvPublic},
     Context, Error, Result, WrapperErrorKind,
 };
 

tss-esapi/src/abstraction/transient/mod.rs

@@ -521,6 +521,11 @@ impl TransientKeyContext {
         }
         Ok(key_handle)
     }
+
+    /// Get a builder for the structure
+    pub fn builder() -> TransientKeyContextBuilder {
+        TransientKeyContextBuilder::new()
+    }
 }
 
 /// Build a new `TransientKeyContext`.

tss-esapi/src/attributes/locality.rs

@@ -51,7 +51,7 @@ impl LocalityAttributes {
     }
 
     /// Returns the builder used to construct LocalAttributes.
-    pub fn builder() -> LocalityAttributesBuilder {
+    pub const fn builder() -> LocalityAttributesBuilder {
         LocalityAttributesBuilder::new()
     }
 }

tss-esapi/src/attributes/nv_index.rs

@@ -107,6 +107,11 @@ impl NvIndexAttributes {
 
         Ok(())
     }
+
+    /// Get a builder for the structure
+    pub const fn builder() -> NvIndexAttributesBuilder {
+        NvIndexAttributesBuilder::new()
+    }
 }
 
 impl TryFrom<TPMA_NV> for NvIndexAttributes {

tss-esapi/src/attributes/object.rs

@@ -58,6 +58,11 @@ impl ObjectAttributes {
         attrs.set_sign_encrypt(true);
         attrs
     }
+
+    /// Get a builder for the structure
+    pub const fn builder() -> ObjectAttributesBuilder {
+        ObjectAttributesBuilder::new()
+    }
 }
 
 impl From<ObjectAttributes> for TPMA_OBJECT {

tss-esapi/src/attributes/session.rs

@@ -24,6 +24,13 @@ bitfield! {
     pub audit, _: 7;
 }
 
+impl SessionAttributes {
+    /// Get a builder for the structure
+    pub const fn builder() -> SessionAttributesBuilder {
+        SessionAttributesBuilder::new()
+    }
+}
+
 impl From<TPMA_SESSION> for SessionAttributes {
     fn from(tss_session_attributes: TPMA_SESSION) -> SessionAttributes {
         SessionAttributes(tss_session_attributes)
@@ -53,6 +60,13 @@ bitfield! {
     _, use_audit: 7;
 }
 
+impl SessionAttributesMask {
+    /// Get a builder for the structure
+    pub const fn builder() -> SessionAttributesBuilder {
+        SessionAttributesBuilder::new()
+    }
+}
+
 impl From<TPMA_SESSION> for SessionAttributesMask {
     fn from(tss_session_attributes: TPMA_SESSION) -> SessionAttributesMask {
         SessionAttributesMask(tss_session_attributes)
@@ -77,7 +91,7 @@ pub struct SessionAttributesBuilder {
 }
 
 impl SessionAttributesBuilder {
-    pub fn new() -> SessionAttributesBuilder {
+    pub const fn new() -> SessionAttributesBuilder {
         SessionAttributesBuilder {
             attributes: SessionAttributes(0),
             mask: SessionAttributesMask(0),

tss-esapi/src/context/tpm_commands/non_volatile_storage.rs

@@ -4,8 +4,7 @@ use crate::{
     context::handle_manager::HandleDropAction,
     handles::{AuthHandle, NvIndexHandle},
     interface_types::resource_handles::{NvAuth, Provision},
-    nv::storage::NvPublic,
-    structures::{Auth, MaxNvBuffer, Name},
+    structures::{Auth, MaxNvBuffer, Name, NvPublic},
     tss2_esys::*,
     Context, Error, Result,
 };

tss-esapi/src/lib.rs

@@ -109,7 +109,6 @@ mod context;
 mod error;
 pub mod handles;
 pub mod interface_types;
-pub mod nv;
 pub mod structures;
 pub mod tcti_ldr;
 pub mod traits;

tss-esapi/src/structures/lists/pcr_selection.rs

@@ -81,6 +81,11 @@ impl PcrSelectionList {
                 .and_then(|existing_pcr_selection| existing_pcr_selection.deselect_exact(pcr_slot))
         })
     }
+
+    /// Get a builder for this structure
+    pub fn builder() -> PcrSelectionListBuilder {
+        PcrSelectionListBuilder::new()
+    }
 }
 
 impl From<PcrSelectionList> for TPML_PCR_SELECTION {

tss-esapi/src/structures/mod.rs

@@ -198,3 +198,9 @@ pub use property::{
     algorithm_property::AlgorithmProperty, tagged_pcr_select::TaggedPcrSelect,
     tagged_property::TaggedProperty,
 };
+
+/////////////////////////////////////////////////////////
+/// NV structures
+/////////////////////////////////////////////////////////
+mod nv;
+pub use nv::storage::{NvPublic, NvPublicBuilder};