opendal 0.1.8 → 0.1.9

data/core/services/hf/README.md

@@ -0,0 +1,56 @@
+# Apache OpenDAL™ Hugging Face Hub Service
+
+`opendal-service-hf` provides access to files hosted on the Hugging Face Hub for
+applications built with Apache OpenDAL™.
+
+## Use through `opendal`
+
+Applications should normally enable this service through the `opendal` facade with the
+`services-hf` feature:
+
+```shell
+cargo add opendal --features services-hf
+```
+
+The service is available as `opendal::services::Hf`. Configure the
+service builder, then pass it to `opendal::Operator::new`.
+
+## Use with `opendal-core`
+
+Add the split crates directly:
+
+```shell
+cargo add opendal-core opendal-service-hf
+```
+
+Pass a configured service builder to `Operator::new`:
+
+```rust
+use opendal_core::{Operator, OperatorRegistry, Result};
+use opendal_service_hf::{register_hf_service, Hf};
+
+fn build_operator(builder: Hf) -> Result<Operator> {
+    Operator::new(builder)
+}
+
+fn register_for_uri() {
+    register_hf_service(OperatorRegistry::get());
+}
+```
+
+`register_for_uri` is only needed for scheme-driven construction through
+`Operator::from_uri` or `Operator::via_iter`.
+
+Services that send HTTP requests also require an HTTP transport in
+`OperationContext`. See the
+[`opendal-core` composition example](https://crates.io/crates/opendal-core).
+
+## Documentation
+
+- [Service configuration and examples](https://opendal.apache.org/services/hf)
+- [Rust API documentation](https://docs.rs/opendal-service-hf)
+- [Apache OpenDAL documentation](https://opendal.apache.org/docs/)
+
+## License
+
+Licensed under the Apache License, Version 2.0.

data/core/services/hf/src/backend.rs

@@ -133,10 +133,12 @@ impl HfBuilder {
         self
     }
 
-    /// configure the Hub base url. You might want to set this variable if your
-    /// organization is using a Private Hub https://huggingface.co/enterprise
+    /// Set the Hub base URL.
     ///
-    /// Default is "https://huggingface.co"
+    /// Configure this when your organization uses a
+    /// [Private Hub](https://huggingface.co/enterprise).
+    ///
+    /// The default is `https://huggingface.co`.
     pub fn endpoint(mut self, endpoint: &str) -> Self {
         if !endpoint.is_empty() {
             self.config.endpoint = Some(endpoint.to_string());
@@ -209,7 +211,7 @@ impl Builder for HfBuilder {
     type Config = HfConfig;
 
     fn build(self) -> Result<impl Service> {
-        debug!("backend build started: {:?}", &self);
+        debug!("backend build started: {:?}", self);
 
         let token = self.hf_token();
         let endpoint = self.hf_endpoint();
@@ -220,25 +222,25 @@ impl Builder for HfBuilder {
                 .with_operation("Builder::build")
                 .with_context("service", HF_SCHEME)
         })?;
-        debug!("backend use repo_type: {:?}", &repo_type);
+        debug!("backend use repo_type: {:?}", repo_type);
 
         let repo_id = self.config.repo_id.ok_or_else(|| {
             Error::new(ErrorKind::ConfigInvalid, "repo_id is required")
                 .with_operation("Builder::build")
                 .with_context("service", HF_SCHEME)
         })?;
-        debug!("backend use repo_id: {}", &repo_id);
+        debug!("backend use repo_id: {}", repo_id);
 
         let revision = match &self.config.revision {
             Some(revision) => revision.clone(),
             None => "main".to_string(),
         };
-        debug!("backend use revision: {}", &revision);
+        debug!("backend use revision: {}", revision);
 
         let root = normalize_root(&self.config.root.unwrap_or_default());
-        debug!("backend use root: {}", &root);
+        debug!("backend use root: {}", root);
         debug!("backend use token: {}", token.is_some());
-        debug!("backend use endpoint: {}", &endpoint);
+        debug!("backend use endpoint: {}", endpoint);
         debug!("backend use download_mode: {:?}", download_mode);
 
         let info = ServiceInfo::new(HF_SCHEME, "", "");

data/core/services/hf/src/config.rs

@@ -50,7 +50,7 @@ pub struct HfConfig {
     pub token: Option<String>,
     /// Endpoint of the Hugging Face Hub.
     ///
-    /// Default is "https://huggingface.co".
+    /// The default is `https://huggingface.co`.
     pub endpoint: Option<String>,
     /// Download mode. Either `xet` (default) or `http`.
     ///

data/core/services/hf/src/core.rs

@@ -916,14 +916,14 @@ mod uri {
         pub fn paths_info_url(&self, endpoint: &str) -> String {
             match self.repo_type {
                 HfRepoType::Bucket => {
-                    format!("{}/api/buckets/{}/paths-info", endpoint, &self.repo_id)
+                    format!("{}/api/buckets/{}/paths-info", endpoint, self.repo_id)
                 }
                 _ => {
                     format!(
                         "{}/api/{}/{}/paths-info/{}",
                         endpoint,
                         self.repo_type.as_plural_str(),
-                        &self.repo_id,
+                        self.repo_id,
                         percent_encode_revision(self.revision()),
                     )
                 }
@@ -936,7 +936,7 @@ mod uri {
                 HfRepoType::Bucket => {
                     format!(
                         "{}/api/buckets/{}/xet-{}-token",
-                        endpoint, &self.repo_id, token_type
+                        endpoint, self.repo_id, token_type
                     )
                 }
                 _ => {
@@ -944,7 +944,7 @@ mod uri {
                         "{}/api/{}/{}/xet-{}-token/{}",
                         endpoint,
                         self.repo_type.as_plural_str(),
-                        &self.repo_id,
+                        self.repo_id,
                         token_type,
                         self.revision(),
                     )
@@ -954,7 +954,7 @@ mod uri {
 
         /// Build the bucket batch API URL for this repository.
         pub fn bucket_batch_url(&self, endpoint: &str) -> String {
-            format!("{}/api/buckets/{}/batch", endpoint, &self.repo_id)
+            format!("{}/api/buckets/{}/batch", endpoint, self.repo_id)
         }
 
         /// Build the git commit API URL for this repository.
@@ -963,7 +963,7 @@ mod uri {
                 "{}/api/{}/{}/commit/{}",
                 endpoint,
                 self.repo_type.as_plural_str(),
-                &self.repo_id,
+                self.repo_id,
                 percent_encode_revision(self.revision()),
             )
         }
@@ -1095,25 +1095,25 @@ mod uri {
                 HfRepoType::Model => {
                     format!(
                         "{}/{}/resolve/{}/{}",
-                        endpoint, &self.repo.repo_id, revision, path
+                        endpoint, self.repo.repo_id, revision, path
                     )
                 }
                 HfRepoType::Dataset => {
                     format!(
                         "{}/datasets/{}/resolve/{}/{}",
-                        endpoint, &self.repo.repo_id, revision, path
+                        endpoint, self.repo.repo_id, revision, path
                     )
                 }
                 HfRepoType::Space => {
                     format!(
                         "{}/spaces/{}/resolve/{}/{}",
-                        endpoint, &self.repo.repo_id, revision, path
+                        endpoint, self.repo.repo_id, revision, path
                     )
                 }
                 HfRepoType::Bucket => {
                     format!(
                         "{}/buckets/{}/resolve/{}",
-                        endpoint, &self.repo.repo_id, path
+                        endpoint, self.repo.repo_id, path
                     )
                 }
             }
@@ -1135,7 +1135,7 @@ mod uri {
                 format!(
                     "{}/api/buckets/{}/tree/{}?expand=True",
                     endpoint,
-                    &self.repo.repo_id,
+                    self.repo.repo_id,
                     percent_encode_path(&self.path),
                 )
             } else {
@@ -1143,7 +1143,7 @@ mod uri {
                     "{}/api/{}/{}/tree/{}/{}?expand=True",
                     endpoint,
                     self.repo.repo_type.as_plural_str(),
-                    &self.repo.repo_id,
+                    self.repo.repo_id,
                     percent_encode_revision(self.revision()),
                     percent_encode_path(&self.path),
                 )

data/core/services/hf/src/docs.md

@@ -11,7 +11,7 @@ This service supports two storage backends:
 
 ## Capabilities
 
-This service can be used to:
+Depending on its configuration and the backing system, this service can expose:
 
 - [ ] create_dir
 - [x] stat
@@ -23,17 +23,14 @@ This service can be used to:
 - [ ] rename
 - [ ] presign
 
-## Configurations
+Inspect the effective capability set with [`opendal_core::Operator::info`] and
+[`opendal_core::OperatorInfo::capability`] after building an operator.
 
-- `repo_type`: The type of the repository. One of `model`, `dataset`, `space`, or `bucket`.
-- `repo_id`: The id of the repository.
-- `revision`: The revision of the repository. Only applicable for git-based repo types (`model`, `dataset`, `space`).
-- `root`: Set the work directory for backend.
-- `token`: The token for accessing the repository. Required for write operations.
-- `endpoint`: The Hub base URL. Default is `https://huggingface.co`. Can also be set via the `HF_ENDPOINT` environment variable.
-- `download_mode`: How files are downloaded. One of `xet` (default) or `http`. When unset, a non-empty `HF_HUB_DISABLE_XET` environment variable forces `http`.
+## Configuration
 
-Refer to [`HfBuilder`]'s public API docs for more information.
+Use [`crate::HfConfig`] for serializable configuration and this builder's
+methods for direct construction. The field and method documentation defines
+accepted values, defaults, and environment interaction.
 
 ## Examples
 
@@ -82,11 +79,13 @@ async fn main() -> Result<()> {
 ### Via URI
 
 ```rust,no_run
-use opendal_core::Operator;
-use opendal_core::Result;
+use opendal_core::{Operator, OperatorRegistry, Result};
+use opendal_service_hf::register_hf_service;
 
 #[tokio::main]
 async fn main() -> Result<()> {
+    register_hf_service(OperatorRegistry::get());
+
     // Git-based dataset
     let op = Operator::from_uri((
         "hf://datasets/username/my-dataset@main",

data/core/services/hf/src/lib.rs

@@ -15,13 +15,23 @@
 // specific language governing permissions and limitations
 // under the License.
 
-/// Primary scheme for the Hugging Face service.
+#![doc = include_str!("../README.md")]
+#![cfg_attr(docsrs, feature(doc_cfg))]
+#![cfg_attr(docsrs, doc(auto_cfg))]
+#![deny(missing_docs)]
+
+/// Primary URI scheme registered for the Hugging Face service.
 pub const HF_SCHEME: &str = "hf";
 
-/// Alias scheme for the Hugging Face service.
+/// Alias URI scheme registered for the Hugging Face service.
 pub const HUGGINGFACE_SCHEME: &str = "huggingface";
 
-/// Register this service into the given registry under both `hf` and `huggingface` schemes.
+/// Register this service's URI scheme or schemes with an operator registry.
+///
+/// Registration enables scheme-driven construction through
+/// [`opendal_core::Operator::from_uri`] and
+/// [`opendal_core::Operator::via_iter`]. Direct construction through
+/// [`opendal_core::Operator::new`] does not require registration.
 pub fn register_hf_service(registry: &opendal_core::OperatorRegistry) {
     registry.register::<Hf>(HF_SCHEME);
     registry.register::<Hf>(HUGGINGFACE_SCHEME);

data/core/services/hf/src/lister.rs

@@ -137,7 +137,7 @@ impl oio::PageList for HfLister {
         for info in response.files {
             let meta = info.metadata()?;
             let path = if meta.mode() == EntryMode::DIR {
-                format!("{}/", &info.path)
+                format!("{}/", info.path)
             } else {
                 info.path.clone()
             };

data/core/services/http/Cargo.toml

@@ -20,8 +20,9 @@ description = "Apache OpenDAL HTTP service implementation"
 edition = "2024"
 license = "Apache-2.0"
 name = "opendal-service-http"
+readme = "README.md"
 repository = "https://github.com/apache/opendal"
-version = "0.58.0"
+version = "0.58.1"
 
 [package.metadata.docs.rs]
 all-features = true
@@ -29,9 +30,9 @@ all-features = true
 [dependencies]
 http = "1.4"
 log = "0.4"
-opendal-core = { path = "../../core", version = "0.58.0", default-features = false }
+opendal-core = { path = "../../core", version = "0.58.1", default-features = false }
 serde = { version = "1", features = ["derive"] }
 
 [dev-dependencies]
-opendal-core = { path = "../../core", version = "0.58.0", default-features = false }
+opendal-core = { path = "../../core", version = "0.58.1", default-features = false }
 tokio = { version = "1.52", features = ["macros", "rt-multi-thread"] }

data/core/services/http/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/core/services/http/NOTICE

@@ -0,0 +1,5 @@
+Apache OpenDAL
+Copyright 2023-2026 The Apache Software Foundation
+
+This product includes software developed at
+The Apache Software Foundation (http://www.apache.org/).

data/core/services/http/README.md

@@ -0,0 +1,56 @@
+# Apache OpenDAL™ HTTP Service
+
+`opendal-service-http` provides access to objects over HTTP and HTTPS for applications
+built with Apache OpenDAL™.
+
+## Use through `opendal`
+
+Applications should normally enable this service through the `opendal` facade with the
+`services-http` feature:
+
+```shell
+cargo add opendal --features services-http
+```
+
+The service is available as `opendal::services::Http`. Configure the
+service builder, then pass it to `opendal::Operator::new`.
+
+## Use with `opendal-core`
+
+Add the split crates directly:
+
+```shell
+cargo add opendal-core opendal-service-http
+```
+
+Pass a configured service builder to `Operator::new`:
+
+```rust
+use opendal_core::{Operator, OperatorRegistry, Result};
+use opendal_service_http::{register_http_service, Http};
+
+fn build_operator(builder: Http) -> Result<Operator> {
+    Operator::new(builder)
+}
+
+fn register_for_uri() {
+    register_http_service(OperatorRegistry::get());
+}
+```
+
+`register_for_uri` is only needed for scheme-driven construction through
+`Operator::from_uri` or `Operator::via_iter`.
+
+Services that send HTTP requests also require an HTTP transport in
+`OperationContext`. See the
+[`opendal-core` composition example](https://crates.io/crates/opendal-core).
+
+## Documentation
+
+- [Service configuration and examples](https://opendal.apache.org/services/http)
+- [Rust API documentation](https://docs.rs/opendal-service-http)
+- [Apache OpenDAL documentation](https://opendal.apache.org/docs/)
+
+## License
+
+Licensed under the Apache License, Version 2.0.

data/core/services/http/src/backend.rs

@@ -104,7 +104,7 @@ impl Builder for HttpBuilder {
     type Config = HttpConfig;
 
     fn build(self) -> Result<impl Service> {
-        debug!("backend build started: {:?}", &self);
+        debug!("backend build started: {:?}", self);
 
         let endpoint = match &self.config.endpoint {
             Some(v) => v,

data/core/services/http/src/docs.md

@@ -1,6 +1,6 @@
 ## Capabilities
 
-This service can be used to:
+Depending on its configuration and the backing system, this service can expose:
 
 - [ ] ~~create_dir~~
 - [x] stat
@@ -12,6 +12,9 @@ This service can be used to:
 - [ ] ~~rename~~
 - [ ] ~~presign~~
 
+Inspect the effective capability set with [`opendal_core::Operator::info`] and
+[`opendal_core::OperatorInfo::capability`] after building an operator.
+
 ## Notes
 
 Only `read` and `stat` are supported. We can use this service to visit any
@@ -19,10 +22,9 @@ HTTP Server like nginx, caddy.
 
 ## Configuration
 
-- `endpoint`: set the endpoint for http
-- `root`: Set the work directory for backend
-
-You can refer to [`HttpBuilder`]'s docs for more information
+Use [`crate::HttpConfig`] for serializable configuration and this builder's
+methods for direct construction. The field and method documentation defines
+accepted values, defaults, and environment interaction.
 
 ## Example