Build #2840275 2026-01-21 21:26:26
# rustc version
rustc 1.95.0-nightly (5c49c4f7c 2026-01-20)# docs.rs version
docsrs 0.1.0 (70ee01e6 2026-01-16 )# build log
[INFO] running `Command { std: "docker" "create" "-v" "/home/cratesfyi/workspace-builder/builds/cot-0.5.0/target:/opt/rustwide/target:rw,Z" "-v" "/home/cratesfyi/workspace-builder/builds/cot-0.5.0/source:/opt/rustwide/workdir:ro,Z" "-v" "/home/cratesfyi/workspace-builder/cargo-home:/opt/rustwide/cargo-home:ro,Z" "-v" "/home/cratesfyi/workspace-builder/rustup-home:/opt/rustwide/rustup-home:ro,Z" "-e" "SOURCE_DIR=/opt/rustwide/workdir" "-e" "CARGO_TARGET_DIR=/opt/rustwide/target" "-e" "DOCS_RS=1" "-e" "CARGO_HOME=/opt/rustwide/cargo-home" "-e" "RUSTUP_HOME=/opt/rustwide/rustup-home" "-w" "/opt/rustwide/workdir" "-m" "6442450944" "--cpus" "6" "--user" "1001:1001" "--network" "none" "ghcr.io/rust-lang/crates-build-env/linux@sha256:98afbf2d16093dec2546ff8915fddc74e65664aa03fc460b3712b1c2c54a33e4" "/opt/rustwide/cargo-home/bin/cargo" "+nightly" "rustdoc" "--lib" "-Zrustdoc-map" "--all-features" "--config" "build.rustdocflags=[\"--cfg\", \"docsrs\", \"--cfg\", \"docsrs\", \"-Z\", \"unstable-options\", \"--emit=invocation-specific\", \"--resource-suffix\", \"-20260120-1.95.0-nightly-5c49c4f7c\", \"--static-root-path\", \"/-/rustdoc.static/\", \"--cap-lints\", \"warn\", \"--extern-html-root-takes-precedence\"]" "--offline" "-Zunstable-options" "--config=doc.extern-map.registries.crates-io=\"https://docs.rs/{pkg_name}/{version}/x86_64-unknown-linux-gnu\"" "-Zrustdoc-scrape-examples" "-j6" "--target" "x86_64-unknown-linux-gnu", kill_on_drop: false }`
[INFO] [stderr] WARNING: Your kernel does not support swap limit capabilities or the cgroup is not mounted. Memory limited without swap.
[INFO] [stdout] 2c64237a281a8007d76dacf22b73fe8505e727098396fe8474456d1e96093b7c
[INFO] running `Command { std: "docker" "start" "-a" "2c64237a281a8007d76dacf22b73fe8505e727098396fe8474456d1e96093b7c", kill_on_drop: false }`
[INFO] [stderr] warning: target filter specified, but no targets matched; this is a no-op
[INFO] [stderr] Documenting cot v0.5.0 (/opt/rustwide/workdir)
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/cache/store/memory.rs:43:1
[INFO] [stderr] |
[INFO] [stderr] 43 | /// Errors specific to the in-memory cache store.
[INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] |
[INFO] [stderr] note: the lint level is defined here
[INFO] [stderr] --> src/lib.rs:45:26
[INFO] [stderr] |
[INFO] [stderr] 45 | #![cfg_attr(docsrs, warn(rustdoc::missing_doc_code_examples))]
[INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/cache/store/memory.rs:74:1
[INFO] [stderr] |
[INFO] [stderr] 74 | / impl Memory {
[INFO] [stderr] 75 | | /// Create a new, empty `Memory` cache store.
[INFO] [stderr] 76 | | ///
[INFO] [stderr] 77 | | /// # Examples
[INFO] [stderr] ... |
[INFO] [stderr] 88 | | }
[INFO] [stderr] | |_^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/cache/store/redis.rs:32:1
[INFO] [stderr] |
[INFO] [stderr] 32 | /// Errors specific to the Redis cache store.
[INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/cache/store/redis.rs:91:1
[INFO] [stderr] |
[INFO] [stderr] 91 | / impl Redis {
[INFO] [stderr] 92 | | /// Creates and configures a new Redis cache store.
[INFO] [stderr] 93 | | ///
[INFO] [stderr] 94 | | /// This initializes a connection pool to the Redis server specified by the
[INFO] [stderr] ... |
[INFO] [stderr] 155 | | }
[INFO] [stderr] | |_^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/cache/store.rs:23:1
[INFO] [stderr] |
[INFO] [stderr] 23 | /// Errors that can occur when interacting with a cache store.
[INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/cache/store.rs:43:1
[INFO] [stderr] |
[INFO] [stderr] 43 | / /// A generic asynchronous cache interface.
[INFO] [stderr] 44 | | ///
[INFO] [stderr] 45 | | /// The `CacheStore` trait abstracts over different cache backends. It supports
[INFO] [stderr] 46 | | /// basic CRUD operations as well as helpers to lazily compute and insert
[INFO] [stderr] 47 | | /// values, with optional expiration policies.
[INFO] [stderr] | |______________________________________________^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/cache/store.rs:49:5
[INFO] [stderr] |
[INFO] [stderr] 49 | / /// Get a value by a given key.
[INFO] [stderr] 50 | | ///
[INFO] [stderr] 51 | | /// # Errors
[INFO] [stderr] 52 | | ///
[INFO] [stderr] 53 | | /// This method can return error if there is an issue retrieving the key.
[INFO] [stderr] | |_____________________________________________________________________________^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/cache/store.rs:56:5
[INFO] [stderr] |
[INFO] [stderr] 56 | / /// Insert a value under the given key.
[INFO] [stderr] 57 | | ///
[INFO] [stderr] 58 | | /// # Errors
[INFO] [stderr] 59 | | ///
[INFO] [stderr] 60 | | /// This method can return error if there is an issue inserting the
[INFO] [stderr] 61 | | /// key-value pair.
[INFO] [stderr] | |_______________________^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/cache/store.rs:69:5
[INFO] [stderr] |
[INFO] [stderr] 69 | / /// Remove a value by key. Succeeds even if the key was absent.
[INFO] [stderr] 70 | | ///
[INFO] [stderr] 71 | | /// # Errors
[INFO] [stderr] 72 | | ///
[INFO] [stderr] 73 | | /// This method can return error if there is an issue removing the key.
[INFO] [stderr] | |___________________________________________________________________________^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/cache/store.rs:76:5
[INFO] [stderr] |
[INFO] [stderr] 76 | / /// Clear all entries in the cache.
[INFO] [stderr] 77 | | ///
[INFO] [stderr] 78 | | /// # Errors
[INFO] [stderr] 79 | | ///
[INFO] [stderr] 80 | | /// This method can return error if there is an issue clearing the cache.
[INFO] [stderr] | |_____________________________________________________________________________^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/cache/store.rs:83:5
[INFO] [stderr] |
[INFO] [stderr] 83 | / /// Get an approximate count of entries in the cache.
[INFO] [stderr] 84 | | ///
[INFO] [stderr] 85 | | /// This is an approximate count and may or may not be exact depending on
[INFO] [stderr] 86 | | /// the backend implementation.
[INFO] [stderr] ... |
[INFO] [stderr] 89 | | ///
[INFO] [stderr] 90 | | /// This method can return error if there is an issue retrieving the length.
[INFO] [stderr] | |________________________________________________________________________________^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/cache/store.rs:93:5
[INFO] [stderr] |
[INFO] [stderr] 93 | / /// Returns `true` if the cache contains the specified key.
[INFO] [stderr] 94 | | ///
[INFO] [stderr] 95 | | /// # Errors
[INFO] [stderr] 96 | | ///
[INFO] [stderr] 97 | | /// This method can return error if there is an issue checking the presence
[INFO] [stderr] 98 | | /// of the key.
[INFO] [stderr] | |___________________^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/cache.rs:131:1
[INFO] [stderr] |
[INFO] [stderr] 131 | /// An error that can occur when interacting with the cache.
[INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/cache.rs:205:1
[INFO] [stderr] |
[INFO] [stderr] 205 | / impl Cache {
[INFO] [stderr] 206 | | /// Creates a new cache instance with the specified store, prefix, and
[INFO] [stderr] 207 | | /// default expiration time.
[INFO] [stderr] 208 | | ///
[INFO] [stderr] ... |
[INFO] [stderr] 799 | | }
[INFO] [stderr] | |_^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db/sea_query_db.rs:126:17
[INFO] [stderr] |
[INFO] [stderr] 126 | #[doc = "A wrapper for the internal row type used by [`"]
[INFO] [stderr] | _________________^
[INFO] [stderr] 127 | | #[doc = stringify!($sqlx_db_ty)]
[INFO] [stderr] 128 | | #[doc = "`] to provide a unified interface for the database operations."]
[INFO] [stderr] | |________________________________________________________________________________^
[INFO] [stderr] |
[INFO] [stderr] ::: src/db/impl_mysql.rs:6:1
[INFO] [stderr] |
[INFO] [stderr] 6 | impl_sea_query_db_backend!(DatabaseMySql: sqlx::mysql::MySql, sqlx::mysql::MySqlPool, MySqlRow, MySqlValueRef, sea_query::MysqlQueryBuilder);
[INFO] [stderr] | -------------------------------------------------------------------------------------------------------------------------------------------- in this macro invocation
[INFO] [stderr] |
[INFO] [stderr] = note: this warning originates in the macro `impl_sea_query_db_backend` (in Nightly builds, run with -Z macro-backtrace for more info)
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db/impl_mysql.rs:6:1
[INFO] [stderr] |
[INFO] [stderr] 6 | impl_sea_query_db_backend!(DatabaseMySql: sqlx::mysql::MySql, sqlx::mysql::MySqlPool, MySqlRow, MySqlValueRef, sea_query::MysqlQueryBuilder);
[INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db/sea_query_db.rs:151:17
[INFO] [stderr] |
[INFO] [stderr] 151 | #[doc = "A wrapper for the internal value type used by [`"]
[INFO] [stderr] | _________________^
[INFO] [stderr] 152 | | #[doc = stringify!($sqlx_db_ty)]
[INFO] [stderr] 153 | | #[doc = "`] to provide a unified interface for the database operations."]
[INFO] [stderr] | |________________________________________________________________________________^
[INFO] [stderr] |
[INFO] [stderr] ::: src/db/impl_mysql.rs:6:1
[INFO] [stderr] |
[INFO] [stderr] 6 | impl_sea_query_db_backend!(DatabaseMySql: sqlx::mysql::MySql, sqlx::mysql::MySqlPool, MySqlRow, MySqlValueRef, sea_query::MysqlQueryBuilder);
[INFO] [stderr] | -------------------------------------------------------------------------------------------------------------------------------------------- in this macro invocation
[INFO] [stderr] |
[INFO] [stderr] = note: this warning originates in the macro `impl_sea_query_db_backend` (in Nightly builds, run with -Z macro-backtrace for more info)
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db/sea_query_db.rs:126:17
[INFO] [stderr] |
[INFO] [stderr] 126 | #[doc = "A wrapper for the internal row type used by [`"]
[INFO] [stderr] | _________________^
[INFO] [stderr] 127 | | #[doc = stringify!($sqlx_db_ty)]
[INFO] [stderr] 128 | | #[doc = "`] to provide a unified interface for the database operations."]
[INFO] [stderr] | |________________________________________________________________________________^
[INFO] [stderr] |
[INFO] [stderr] ::: src/db/impl_postgres.rs:5:1
[INFO] [stderr] |
[INFO] [stderr] 5 | impl_sea_query_db_backend!(DatabasePostgres: sqlx::postgres::Postgres, sqlx::postgres::PgPool, PostgresRow, PostgresValueRef, sea_query::PostgresQueryBuilder);
[INFO] [stderr] | -------------------------------------------------------------------------------------------------------------------------------------------------------------- in this macro invocation
[INFO] [stderr] |
[INFO] [stderr] = note: this warning originates in the macro `impl_sea_query_db_backend` (in Nightly builds, run with -Z macro-backtrace for more info)
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db/impl_postgres.rs:5:1
[INFO] [stderr] |
[INFO] [stderr] 5 | impl_sea_query_db_backend!(DatabasePostgres: sqlx::postgres::Postgres, sqlx::postgres::PgPool, PostgresRow, PostgresValueRef, sea_query::PostgresQueryBuilder);
[INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db/sea_query_db.rs:151:17
[INFO] [stderr] |
[INFO] [stderr] 151 | #[doc = "A wrapper for the internal value type used by [`"]
[INFO] [stderr] | _________________^
[INFO] [stderr] 152 | | #[doc = stringify!($sqlx_db_ty)]
[INFO] [stderr] 153 | | #[doc = "`] to provide a unified interface for the database operations."]
[INFO] [stderr] | |________________________________________________________________________________^
[INFO] [stderr] |
[INFO] [stderr] ::: src/db/impl_postgres.rs:5:1
[INFO] [stderr] |
[INFO] [stderr] 5 | impl_sea_query_db_backend!(DatabasePostgres: sqlx::postgres::Postgres, sqlx::postgres::PgPool, PostgresRow, PostgresValueRef, sea_query::PostgresQueryBuilder);
[INFO] [stderr] | -------------------------------------------------------------------------------------------------------------------------------------------------------------- in this macro invocation
[INFO] [stderr] |
[INFO] [stderr] = note: this warning originates in the macro `impl_sea_query_db_backend` (in Nightly builds, run with -Z macro-backtrace for more info)
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db/sea_query_db.rs:126:17
[INFO] [stderr] |
[INFO] [stderr] 126 | #[doc = "A wrapper for the internal row type used by [`"]
[INFO] [stderr] | _________________^
[INFO] [stderr] 127 | | #[doc = stringify!($sqlx_db_ty)]
[INFO] [stderr] 128 | | #[doc = "`] to provide a unified interface for the database operations."]
[INFO] [stderr] | |________________________________________________________________________________^
[INFO] [stderr] |
[INFO] [stderr] ::: src/db/impl_sqlite.rs:7:1
[INFO] [stderr] |
[INFO] [stderr] 7 | impl_sea_query_db_backend!(DatabaseSqlite: sqlx::sqlite::Sqlite, sqlx::sqlite::SqlitePool, SqliteRow, SqliteValueRef, sea_query::SqliteQueryBuilder);
[INFO] [stderr] | ---------------------------------------------------------------------------------------------------------------------------------------------------- in this macro invocation
[INFO] [stderr] |
[INFO] [stderr] = note: this warning originates in the macro `impl_sea_query_db_backend` (in Nightly builds, run with -Z macro-backtrace for more info)
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db/impl_sqlite.rs:7:1
[INFO] [stderr] |
[INFO] [stderr] 7 | impl_sea_query_db_backend!(DatabaseSqlite: sqlx::sqlite::Sqlite, sqlx::sqlite::SqlitePool, SqliteRow, SqliteValueRef, sea_query::SqliteQueryBuilder);
[INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db/sea_query_db.rs:151:17
[INFO] [stderr] |
[INFO] [stderr] 151 | #[doc = "A wrapper for the internal value type used by [`"]
[INFO] [stderr] | _________________^
[INFO] [stderr] 152 | | #[doc = stringify!($sqlx_db_ty)]
[INFO] [stderr] 153 | | #[doc = "`] to provide a unified interface for the database operations."]
[INFO] [stderr] | |________________________________________________________________________________^
[INFO] [stderr] |
[INFO] [stderr] ::: src/db/impl_sqlite.rs:7:1
[INFO] [stderr] |
[INFO] [stderr] 7 | impl_sea_query_db_backend!(DatabaseSqlite: sqlx::sqlite::Sqlite, sqlx::sqlite::SqlitePool, SqliteRow, SqliteValueRef, sea_query::SqliteQueryBuilder);
[INFO] [stderr] | ---------------------------------------------------------------------------------------------------------------------------------------------------- in this macro invocation
[INFO] [stderr] |
[INFO] [stderr] = note: this warning originates in the macro `impl_sea_query_db_backend` (in Nightly builds, run with -Z macro-backtrace for more info)
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db/migrations.rs:16:1
[INFO] [stderr] |
[INFO] [stderr] 16 | /// An error that occurred while running migrations.
[INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db/migrations.rs:63:1
[INFO] [stderr] |
[INFO] [stderr] 63 | / impl MigrationEngine {
[INFO] [stderr] 64 | | /// Creates a new [`MigrationEngine`] from a list of migrations.
[INFO] [stderr] 65 | | ///
[INFO] [stderr] 66 | | /// # Errors
[INFO] [stderr] ... |
[INFO] [stderr] 238 | | }
[INFO] [stderr] | |_^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db/migrations.rs:270:1
[INFO] [stderr] |
[INFO] [stderr] 270 | / impl Operation {
[INFO] [stderr] 271 | | #[must_use]
[INFO] [stderr] 272 | | const fn new(inner: OperationInner) -> Self {
[INFO] [stderr] 273 | | Self { inner }
[INFO] [stderr] ... |
[INFO] [stderr] 584 | | }
[INFO] [stderr] | |_^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db/migrations.rs:611:1
[INFO] [stderr] |
[INFO] [stderr] 611 | /// A field in a model.
[INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db/migrations.rs:631:1
[INFO] [stderr] |
[INFO] [stderr] 631 | / impl Field {
[INFO] [stderr] 632 | | /// Creates a new field for use in a migration operation.
[INFO] [stderr] 633 | | ///
[INFO] [stderr] 634 | | /// # Cot CLI Usage
[INFO] [stderr] ... |
[INFO] [stderr] 839 | | }
[INFO] [stderr] | |_^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db/migrations.rs:900:1
[INFO] [stderr] |
[INFO] [stderr] 900 | / impl CreateModelBuilder {
[INFO] [stderr] 901 | | #[must_use]
[INFO] [stderr] 902 | | const fn new() -> Self {
[INFO] [stderr] 903 | | Self {
[INFO] [stderr] ... |
[INFO] [stderr] 1028 | | }
[INFO] [stderr] | |_^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db/migrations.rs:1078:1
[INFO] [stderr] |
[INFO] [stderr] 1078 | / impl AddFieldBuilder {
[INFO] [stderr] 1079 | | #[must_use]
[INFO] [stderr] 1080 | | const fn new() -> Self {
[INFO] [stderr] 1081 | | Self {
[INFO] [stderr] ... |
[INFO] [stderr] 1214 | | }
[INFO] [stderr] | |_^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db/migrations.rs:1264:1
[INFO] [stderr] |
[INFO] [stderr] 1264 | / impl RemoveFieldBuilder {
[INFO] [stderr] 1265 | | #[must_use]
[INFO] [stderr] 1266 | | const fn new() -> Self {
[INFO] [stderr] 1267 | | Self {
[INFO] [stderr] ... |
[INFO] [stderr] 1406 | | }
[INFO] [stderr] | |_^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db/migrations.rs:1457:1
[INFO] [stderr] |
[INFO] [stderr] 1457 | / impl RemoveModelBuilder {
[INFO] [stderr] 1458 | | #[must_use]
[INFO] [stderr] 1459 | | const fn new() -> Self {
[INFO] [stderr] 1460 | | Self {
[INFO] [stderr] ... |
[INFO] [stderr] 1537 | | }
[INFO] [stderr] | |_^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db/migrations.rs:1512:5
[INFO] [stderr] |
[INFO] [stderr] 1512 | / /// Sets the fields to store for potential backwards migration.
[INFO] [stderr] 1513 | | ///
[INFO] [stderr] 1514 | | /// # Cot CLI Usage
[INFO] [stderr] 1515 | | ///
[INFO] [stderr] 1516 | | /// Typically, you shouldn't need to use this directly. Instead, in most
[INFO] [stderr] 1517 | | /// cases, this can be automatically generated by the Cot CLI.
[INFO] [stderr] | |__________________________________________________________________^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db/migrations.rs:1524:5
[INFO] [stderr] |
[INFO] [stderr] 1524 | / /// Builds the operation.
[INFO] [stderr] 1525 | | ///
[INFO] [stderr] 1526 | | /// # Cot CLI Usage
[INFO] [stderr] 1527 | | ///
[INFO] [stderr] 1528 | | /// Typically, you shouldn't need to use this directly. Instead, in most
[INFO] [stderr] 1529 | | /// cases, this can be automatically generated by the Cot CLI.
[INFO] [stderr] | |__________________________________________________________________^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db/migrations.rs:1580:1
[INFO] [stderr] |
[INFO] [stderr] 1580 | / /// A trait for defining a migration that can be dynamically applied.
[INFO] [stderr] 1581 | | ///
[INFO] [stderr] 1582 | | /// This is mostly useful for use in the [`MigrationEngine`] to allow
[INFO] [stderr] 1583 | | /// migrations to be dynamically loaded from multiple apps. This can also be
[INFO] [stderr] ... |
[INFO] [stderr] 1587 | | /// This trait has a blanket implementation for types that implement
[INFO] [stderr] 1588 | | /// [`Migration`].
[INFO] [stderr] | |__________________^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db/migrations.rs:1590:5
[INFO] [stderr] |
[INFO] [stderr] 1590 | /// The name of the app that this migration belongs to.
[INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db/migrations.rs:1593:5
[INFO] [stderr] |
[INFO] [stderr] 1593 | /// The name of the migration.
[INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db/migrations.rs:1596:5
[INFO] [stderr] |
[INFO] [stderr] 1596 | /// The list of dependencies of the migration.
[INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db/migrations.rs:1599:5
[INFO] [stderr] |
[INFO] [stderr] 1599 | /// The list of operations to apply in the migration.
[INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db/migrations.rs:1758:1
[INFO] [stderr] |
[INFO] [stderr] 1758 | / /// A migration dependency: a relationship between two migrations that tells the
[INFO] [stderr] 1759 | | /// migration engine which migrations need to be applied before
[INFO] [stderr] 1760 | | /// others.
[INFO] [stderr] | |___________^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db/migrations.rs:1778:1
[INFO] [stderr] |
[INFO] [stderr] 1778 | / impl MigrationDependency {
[INFO] [stderr] 1779 | | #[must_use]
[INFO] [stderr] 1780 | | const fn new(inner: MigrationDependencyInner) -> Self {
[INFO] [stderr] 1781 | | Self { inner }
[INFO] [stderr] ... |
[INFO] [stderr] 1802 | | }
[INFO] [stderr] | |_^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db/migrations.rs:1784:5
[INFO] [stderr] |
[INFO] [stderr] 1784 | / /// Creates a dependency on another migration.
[INFO] [stderr] 1785 | | ///
[INFO] [stderr] 1786 | | /// This ensures that the migration engine will apply the migration with
[INFO] [stderr] 1787 | | /// given app and migration name before the current migration.
[INFO] [stderr] | |__________________________________________________________________^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db/migrations.rs:1793:5
[INFO] [stderr] |
[INFO] [stderr] 1793 | / /// Creates a dependency on a model.
[INFO] [stderr] 1794 | | ///
[INFO] [stderr] 1795 | | /// This ensures that the migration engine will apply the migration that
[INFO] [stderr] 1796 | | /// creates the model with the given app and table name before the current
[INFO] [stderr] 1797 | | /// migration.
[INFO] [stderr] | |__________________^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db/query.rs:77:1
[INFO] [stderr] |
[INFO] [stderr] 77 | / impl<T: Model> Query<T> {
[INFO] [stderr] 78 | | /// Create a new query.
[INFO] [stderr] 79 | | ///
[INFO] [stderr] 80 | | /// # Example
[INFO] [stderr] ... |
[INFO] [stderr] 252 | | }
[INFO] [stderr] | |_^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db/query.rs:175:5
[INFO] [stderr] |
[INFO] [stderr] 175 | / /// Execute the query and return all results.
[INFO] [stderr] 176 | | ///
[INFO] [stderr] 177 | | /// # Errors
[INFO] [stderr] 178 | | ///
[INFO] [stderr] 179 | | /// Returns an error if the query fails.
[INFO] [stderr] | |____________________________________________^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db/query.rs:184:5
[INFO] [stderr] |
[INFO] [stderr] 184 | / /// Execute the query and return the first result.
[INFO] [stderr] 185 | | ///
[INFO] [stderr] 186 | | /// # Errors
[INFO] [stderr] 187 | | ///
[INFO] [stderr] 188 | | /// Returns an error if the query fails.
[INFO] [stderr] | |____________________________________________^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db/query.rs:194:5
[INFO] [stderr] |
[INFO] [stderr] 194 | / /// Execute the query and return the number of results.
[INFO] [stderr] 195 | | ///
[INFO] [stderr] 196 | | /// # Errors
[INFO] [stderr] 197 | | ///
[INFO] [stderr] 198 | | /// Returns an error if the query fails.
[INFO] [stderr] | |____________________________________________^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db/query.rs:214:5
[INFO] [stderr] |
[INFO] [stderr] 214 | / /// Execute the query and check if any results exist.
[INFO] [stderr] 215 | | ///
[INFO] [stderr] 216 | | /// # Errors
[INFO] [stderr] 217 | | ///
[INFO] [stderr] 218 | | /// Returns an error if the query fails.
[INFO] [stderr] | |____________________________________________^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db/query.rs:223:5
[INFO] [stderr] |
[INFO] [stderr] 223 | / /// Delete all rows that match the query.
[INFO] [stderr] 224 | | ///
[INFO] [stderr] 225 | | /// # Errors
[INFO] [stderr] 226 | | ///
[INFO] [stderr] 227 | | /// Returns an error if the query fails.
[INFO] [stderr] | |____________________________________________^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db/query.rs:600:1
[INFO] [stderr] |
[INFO] [stderr] 600 | / impl Expr {
[INFO] [stderr] 601 | | /// Create a new field expression. This represents a reference to a column
[INFO] [stderr] 602 | | /// in the database.
[INFO] [stderr] 603 | | ///
[INFO] [stderr] ... |
[INFO] [stderr] 1025 | | }
[INFO] [stderr] | |_^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db/query.rs:1027:1
[INFO] [stderr] |
[INFO] [stderr] 1027 | / /// A reference to a field in a database table.
[INFO] [stderr] 1028 | | ///
[INFO] [stderr] 1029 | | /// This is used to create expressions that reference a specific column in a
[INFO] [stderr] 1030 | | /// table with a specific type. This allows for type-safe creation of queries
[INFO] [stderr] 1031 | | /// with some common operators like `=`, `!=`, `+`, `-`, `*`, and `/`.
[INFO] [stderr] | |______________________________________________________________________^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db/query.rs:1038:1
[INFO] [stderr] |
[INFO] [stderr] 1038 | / impl<T: FromDbValue + ToDbFieldValue> FieldRef<T> {
[INFO] [stderr] 1039 | | /// Create a new field reference.
[INFO] [stderr] 1040 | | #[must_use]
[INFO] [stderr] 1041 | | pub const fn new(identifier: Identifier) -> Self {
[INFO] [stderr] ... |
[INFO] [stderr] 1047 | | }
[INFO] [stderr] | |_^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db/query.rs:1039:5
[INFO] [stderr] |
[INFO] [stderr] 1039 | /// Create a new field reference.
[INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db/query.rs:1049:1
[INFO] [stderr] |
[INFO] [stderr] 1049 | / impl<T> FieldRef<T> {
[INFO] [stderr] 1050 | | /// Returns the field reference as an [`Expr`].
[INFO] [stderr] 1051 | | #[must_use]
[INFO] [stderr] 1052 | | pub fn as_expr(&self) -> Expr {
[INFO] [stderr] ... |
[INFO] [stderr] 1055 | | }
[INFO] [stderr] | |_^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db/query.rs:1050:5
[INFO] [stderr] |
[INFO] [stderr] 1050 | /// Returns the field reference as an [`Expr`].
[INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db/query.rs:1057:1
[INFO] [stderr] |
[INFO] [stderr] 1057 | /// A trait for types that can be compared in database expressions.
[INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db/query.rs:1118:1
[INFO] [stderr] |
[INFO] [stderr] 1118 | /// A trait for database types that can be added to each other.
[INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db/query.rs:1144:1
[INFO] [stderr] |
[INFO] [stderr] 1144 | /// A trait for database types that can be subtracted from each other.
[INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db/query.rs:1170:1
[INFO] [stderr] |
[INFO] [stderr] 1170 | /// A trait for database types that can be multiplied by each other.
[INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db/query.rs:1196:1
[INFO] [stderr] |
[INFO] [stderr] 1196 | /// A trait for database types that can be divided by each other.
[INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db/query.rs:1222:1
[INFO] [stderr] |
[INFO] [stderr] 1222 | /// A trait for database types that can be ordered.
[INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db/query.rs:1390:5
[INFO] [stderr] |
[INFO] [stderr] 1390 | /// Converts the type to the field type.
[INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db.rs:48:1
[INFO] [stderr] |
[INFO] [stderr] 48 | /// An error that can occur when interacting with the database.
[INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db.rs:121:1
[INFO] [stderr] |
[INFO] [stderr] 121 | / impl DatabaseError {
[INFO] [stderr] 122 | | /// Creates a new database error from a value decode error.
[INFO] [stderr] 123 | | #[must_use]
[INFO] [stderr] 124 | | pub fn value_decode(error: impl std::error::Error + 'static + Send + Sync) -> Self {
[INFO] [stderr] ... |
[INFO] [stderr] 127 | | }
[INFO] [stderr] | |_^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db.rs:122:5
[INFO] [stderr] |
[INFO] [stderr] 122 | /// Creates a new database error from a value decode error.
[INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db.rs:189:5
[INFO] [stderr] |
[INFO] [stderr] 189 | / /// Creates a model instance from a database row.
[INFO] [stderr] 190 | | ///
[INFO] [stderr] 191 | | /// # Errors
[INFO] [stderr] 192 | | ///
[INFO] [stderr] 193 | | /// This method can return an error if the data in the row is not compatible
[INFO] [stderr] 194 | | /// with the model.
[INFO] [stderr] | |_______________________^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db.rs:197:5
[INFO] [stderr] |
[INFO] [stderr] 197 | / /// Updates the model instance from a database row.
[INFO] [stderr] 198 | | ///
[INFO] [stderr] 199 | | /// This is used by the ORM to update the model instance after saving with
[INFO] [stderr] 200 | | /// the data for the [`Auto`] fields.
[INFO] [stderr] ... |
[INFO] [stderr] 204 | | /// This method can return an error if the data in the row is not compatible
[INFO] [stderr] 205 | | /// with the model.
[INFO] [stderr] | |_______________________^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db.rs:208:5
[INFO] [stderr] |
[INFO] [stderr] 208 | /// Returns the primary key of the model.
[INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db.rs:211:5
[INFO] [stderr] |
[INFO] [stderr] 211 | / /// Used by the ORM to set the primary key of the model after it has been
[INFO] [stderr] 212 | | /// saved to the database.
[INFO] [stderr] | |______________________________^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db.rs:215:5
[INFO] [stderr] |
[INFO] [stderr] 215 | /// Gets the values of the model for the given columns.
[INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db.rs:218:5
[INFO] [stderr] |
[INFO] [stderr] 218 | /// Returns a query for all objects of this model.
[INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db.rs:224:5
[INFO] [stderr] |
[INFO] [stderr] 224 | / /// Queries the database for a model instance with the given primary key.
[INFO] [stderr] 225 | | ///
[INFO] [stderr] 226 | | /// # Errors
[INFO] [stderr] 227 | | ///
[INFO] [stderr] 228 | | /// This method can return an error if the model instance could not be
[INFO] [stderr] 229 | | /// found in the database, or there was a problem with the database
[INFO] [stderr] 230 | | /// connection.
[INFO] [stderr] | |___________________^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db.rs:236:5
[INFO] [stderr] |
[INFO] [stderr] 236 | / /// Inserts the model instance to the database, or updates an instance
[INFO] [stderr] 237 | | /// with the same primary key if it already exists.
[INFO] [stderr] 238 | | ///
[INFO] [stderr] 239 | | /// To force insert or force update, use the [`Self::insert`] or
[INFO] [stderr] ... |
[INFO] [stderr] 246 | | /// haven't been applied, or there was a problem with the database
[INFO] [stderr] 247 | | /// connection.
[INFO] [stderr] | |___________________^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db.rs:253:5
[INFO] [stderr] |
[INFO] [stderr] 253 | / /// Insert the model instance to the database.
[INFO] [stderr] 254 | | ///
[INFO] [stderr] 255 | | /// # Errors
[INFO] [stderr] 256 | | ///
[INFO] [stderr] ... |
[INFO] [stderr] 259 | | /// haven't been applied, or there was a problem with the database
[INFO] [stderr] 260 | | /// connection.
[INFO] [stderr] | |___________________^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db.rs:266:5
[INFO] [stderr] |
[INFO] [stderr] 266 | / /// Update the model instance in the database.
[INFO] [stderr] 267 | | ///
[INFO] [stderr] 268 | | /// # Errors
[INFO] [stderr] 269 | | ///
[INFO] [stderr] ... |
[INFO] [stderr] 275 | | /// This method can return an error if the model with the given primary key
[INFO] [stderr] 276 | | /// could not be found in the database.
[INFO] [stderr] | |___________________________________________^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db.rs:282:5
[INFO] [stderr] |
[INFO] [stderr] 282 | / /// Bulk insert multiple model instances to the database in a single query.
[INFO] [stderr] 283 | | ///
[INFO] [stderr] 284 | | /// This method is significantly faster than calling [`Self::insert`]
[INFO] [stderr] 285 | | /// multiple times, as it combines all instances into a single SQL
[INFO] [stderr] ... |
[INFO] [stderr] 319 | | /// assert!(todos[0].id.is_fixed());
[INFO] [stderr] 320 | | /// ```
[INFO] [stderr] | |___________^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db.rs:326:5
[INFO] [stderr] |
[INFO] [stderr] 326 | / /// Bulk insert multiple model instances to the database in a single query,
[INFO] [stderr] 327 | | /// or updates existing instances with the same primary keys.
[INFO] [stderr] 328 | | ///
[INFO] [stderr] 329 | | /// This method is significantly faster than calling
[INFO] [stderr] ... |
[INFO] [stderr] 358 | | /// assert!(todos[0].id.is_fixed());
[INFO] [stderr] 359 | | /// ```
[INFO] [stderr] | |___________^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db.rs:369:1
[INFO] [stderr] |
[INFO] [stderr] 369 | /// An identifier structure that holds table or column name as a string.
[INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db.rs:373:1
[INFO] [stderr] |
[INFO] [stderr] 373 | / impl Identifier {
[INFO] [stderr] 374 | | /// Creates a new identifier from a static string.
[INFO] [stderr] 375 | | #[must_use]
[INFO] [stderr] 376 | | pub const fn new(s: &'static str) -> Self {
[INFO] [stderr] ... |
[INFO] [stderr] 385 | | }
[INFO] [stderr] | |_^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db.rs:374:5
[INFO] [stderr] |
[INFO] [stderr] 374 | /// Creates a new identifier from a static string.
[INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db.rs:380:5
[INFO] [stderr] |
[INFO] [stderr] 380 | /// Returns the inner string of the identifier.
[INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db.rs:404:1
[INFO] [stderr] |
[INFO] [stderr] 404 | / /// A column structure that holds the name of the column and some additional
[INFO] [stderr] 405 | | /// schema information.
[INFO] [stderr] | |_______________________^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db.rs:411:1
[INFO] [stderr] |
[INFO] [stderr] 411 | / impl Column {
[INFO] [stderr] 412 | | /// Creates a new column with the given name.
[INFO] [stderr] 413 | | #[must_use]
[INFO] [stderr] 414 | | pub const fn new(name: Identifier) -> Self {
[INFO] [stderr] ... |
[INFO] [stderr] 417 | | }
[INFO] [stderr] | |_^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db.rs:412:5
[INFO] [stderr] |
[INFO] [stderr] 412 | /// Creates a new column with the given name.
[INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db.rs:419:1
[INFO] [stderr] |
[INFO] [stderr] 419 | / /// A marker trait that denotes that a type can be used as a primary key in a
[INFO] [stderr] 420 | | /// database.
[INFO] [stderr] | |_____________^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db.rs:423:1
[INFO] [stderr] |
[INFO] [stderr] 423 | / /// A row structure that holds the data of a single row retrieved from the
[INFO] [stderr] 424 | | /// database.
[INFO] [stderr] | |_____________^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db.rs:439:1
[INFO] [stderr] |
[INFO] [stderr] 439 | / impl Row {
[INFO] [stderr] 440 | | /// Gets the value at the given index and converts it to the given type.
[INFO] [stderr] 441 | | /// The index is zero-based.
[INFO] [stderr] 442 | | ///
[INFO] [stderr] ... |
[INFO] [stderr] 468 | | }
[INFO] [stderr] | |_^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db.rs:440:5
[INFO] [stderr] |
[INFO] [stderr] 440 | / /// Gets the value at the given index and converts it to the given type.
[INFO] [stderr] 441 | | /// The index is zero-based.
[INFO] [stderr] 442 | | ///
[INFO] [stderr] 443 | | /// # Errors
[INFO] [stderr] ... |
[INFO] [stderr] 448 | | /// This can also return an error if the index is out of bounds of the row
[INFO] [stderr] 449 | | /// returned by the database.
[INFO] [stderr] | |_________________________________^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db.rs:470:1
[INFO] [stderr] |
[INFO] [stderr] 470 | /// A trait denoting that some type can be used as a field in a database.
[INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db.rs:498:1
[INFO] [stderr] |
[INFO] [stderr] 498 | /// A trait for converting a database value to a Rust value.
[INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db.rs:500:5
[INFO] [stderr] |
[INFO] [stderr] 500 | / /// Converts the given SQLite database value to a Rust value.
[INFO] [stderr] 501 | | ///
[INFO] [stderr] 502 | | /// # Errors
[INFO] [stderr] 503 | | ///
[INFO] [stderr] 504 | | /// This method can return an error if the value is not compatible with the
[INFO] [stderr] 505 | | /// Rust type.
[INFO] [stderr] | |__________________^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db.rs:511:5
[INFO] [stderr] |
[INFO] [stderr] 511 | / /// Converts the given PostgreSQL database value to a Rust value.
[INFO] [stderr] 512 | | ///
[INFO] [stderr] 513 | | /// # Errors
[INFO] [stderr] 514 | | ///
[INFO] [stderr] 515 | | /// This method can return an error if the value is not compatible with the
[INFO] [stderr] 516 | | /// Rust type.
[INFO] [stderr] | |__________________^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db.rs:522:5
[INFO] [stderr] |
[INFO] [stderr] 522 | / /// Converts the given MySQL database value to a Rust value.
[INFO] [stderr] 523 | | ///
[INFO] [stderr] 524 | | /// # Errors
[INFO] [stderr] 525 | | ///
[INFO] [stderr] 526 | | /// This method can return an error if the value is not compatible with the
[INFO] [stderr] 527 | | /// Rust type.
[INFO] [stderr] | |__________________^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db.rs:537:1
[INFO] [stderr] |
[INFO] [stderr] 537 | /// A trait for converting a Rust value to a database value.
[INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db.rs:539:5
[INFO] [stderr] |
[INFO] [stderr] 539 | / /// Converts the Rust value to a `sea_query` value.
[INFO] [stderr] 540 | | ///
[INFO] [stderr] 541 | | /// This method is used to convert the Rust value to a value that can be
[INFO] [stderr] 542 | | /// used in a query.
[INFO] [stderr] | |________________________^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db.rs:546:1
[INFO] [stderr] |
[INFO] [stderr] 546 | / /// A generalization of [`ToDbValue`] that can also return a marker that means a
[INFO] [stderr] 547 | | /// value should be automatically generated by the database.
[INFO] [stderr] | |____________________________________________________________^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db.rs:549:5
[INFO] [stderr] |
[INFO] [stderr] 549 | / /// Converts the Rust value to a [`DbFieldValue`] that indicates whether
[INFO] [stderr] 550 | | /// the value should be automatically generated by the database, or
[INFO] [stderr] 551 | | /// contains a specific, explicitly provided value.
[INFO] [stderr] | |_______________________________________________________^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db.rs:618:1
[INFO] [stderr] |
[INFO] [stderr] 618 | / impl DbFieldValue {
[INFO] [stderr] 619 | | /// Returns true if the field value is automatically generated by the
[INFO] [stderr] 620 | | /// database.
[INFO] [stderr] 621 | | ///
[INFO] [stderr] ... |
[INFO] [stderr] 700 | | }
[INFO] [stderr] | |_^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db.rs:728:1
[INFO] [stderr] |
[INFO] [stderr] 728 | / /// A trait for accessing raw database values from a specific database backend.
[INFO] [stderr] 729 | | /// This provides low-level access to database-specific value references.
[INFO] [stderr] | |_________________________________________________________________________^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db.rs:734:5
[INFO] [stderr] |
[INFO] [stderr] 734 | /// Returns the raw database value reference.
[INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db.rs:788:1
[INFO] [stderr] |
[INFO] [stderr] 788 | / /// A database connection structure that holds the connection to the database.
[INFO] [stderr] 789 | | ///
[INFO] [stderr] 790 | | /// It is used to execute queries and interact with the database. The connection
[INFO] [stderr] 791 | | /// is established when the structure is created and closed when
[INFO] [stderr] 792 | | /// [`Self::close()`] is called.
[INFO] [stderr] | |________________________________^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db.rs:808:1
[INFO] [stderr] |
[INFO] [stderr] 808 | / impl Database {
[INFO] [stderr] 809 | | /// Creates a new database connection. The connection string should be in
[INFO] [stderr] 810 | | /// the format of the database URL.
[INFO] [stderr] 811 | | ///
[INFO] [stderr] ... |
[INFO] [stderr] 1574 | | }
[INFO] [stderr] | |_^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db.rs:896:5
[INFO] [stderr] |
[INFO] [stderr] 896 | / /// Inserts a new row into the database.
[INFO] [stderr] 897 | | ///
[INFO] [stderr] 898 | | /// # Errors
[INFO] [stderr] 899 | | ///
[INFO] [stderr] 900 | | /// This method can return an error if the row could not be inserted into
[INFO] [stderr] 901 | | /// the database, for instance because the migrations haven't been
[INFO] [stderr] 902 | | /// applied, or there was a problem with the database connection.
[INFO] [stderr] | |_____________________________________________________________________^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db.rs:911:5
[INFO] [stderr] |
[INFO] [stderr] 911 | / /// Inserts a new row into the database, or updates it if a row with the
[INFO] [stderr] 912 | | /// same primary key already exists.
[INFO] [stderr] 913 | | ///
[INFO] [stderr] 914 | | /// # Errors
[INFO] [stderr] ... |
[INFO] [stderr] 917 | | /// the database, for instance because the migrations haven't been
[INFO] [stderr] 918 | | /// applied, or there was a problem with the database connection.
[INFO] [stderr] | |_____________________________________________________________________^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db.rs:1016:5
[INFO] [stderr] |
[INFO] [stderr] 1016 | / /// Updates an existing row in a database.
[INFO] [stderr] 1017 | | ///
[INFO] [stderr] 1018 | | /// # Errors
[INFO] [stderr] 1019 | | ///
[INFO] [stderr] ... |
[INFO] [stderr] 1024 | | /// This method can return an error if the row with the given primary key
[INFO] [stderr] 1025 | | /// could not be found in the database.
[INFO] [stderr] | |___________________________________________^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db.rs:1081:5
[INFO] [stderr] |
[INFO] [stderr] 1081 | / /// Bulk inserts multiple rows into the database.
[INFO] [stderr] 1082 | | ///
[INFO] [stderr] 1083 | | /// # Errors
[INFO] [stderr] 1084 | | ///
[INFO] [stderr] 1085 | | /// This method can return an error if the rows could not be inserted into
[INFO] [stderr] 1086 | | /// the database, for instance because the migrations haven't been
[INFO] [stderr] 1087 | | /// applied, or there was a problem with the database connection.
[INFO] [stderr] | |_____________________________________________________________________^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db.rs:1096:5
[INFO] [stderr] |
[INFO] [stderr] 1096 | / /// Bulk inserts multiple rows into the database, or updates them if they
[INFO] [stderr] 1097 | | /// already exist.
[INFO] [stderr] 1098 | | ///
[INFO] [stderr] 1099 | | /// # Errors
[INFO] [stderr] ... |
[INFO] [stderr] 1102 | | /// the database, for instance because the migrations haven't been
[INFO] [stderr] 1103 | | /// applied, or there was a problem with the database connection.
[INFO] [stderr] | |_____________________________________________________________________^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db.rs:1317:5
[INFO] [stderr] |
[INFO] [stderr] 1317 | / /// Executes the given query and returns the results converted to the model
[INFO] [stderr] 1318 | | /// type.
[INFO] [stderr] 1319 | | ///
[INFO] [stderr] 1320 | | /// # Errors
[INFO] [stderr] ... |
[INFO] [stderr] 1327 | | ///
[INFO] [stderr] 1328 | | /// Can return an error if the database connection is lost.
[INFO] [stderr] | |_______________________________________________________________^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db.rs:1343:5
[INFO] [stderr] |
[INFO] [stderr] 1343 | / /// Returns the first row that matches the given query. If no rows match the
[INFO] [stderr] 1344 | | /// query, returns `None`.
[INFO] [stderr] 1345 | | ///
[INFO] [stderr] 1346 | | /// # Errors
[INFO] [stderr] ... |
[INFO] [stderr] 1353 | | ///
[INFO] [stderr] 1354 | | /// Can return an error if the database connection is lost.
[INFO] [stderr] | |_______________________________________________________________^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db.rs:1371:5
[INFO] [stderr] |
[INFO] [stderr] 1371 | / /// Returns whether a row exists that matches the given query.
[INFO] [stderr] 1372 | | ///
[INFO] [stderr] 1373 | | /// # Errors
[INFO] [stderr] 1374 | | ///
[INFO] [stderr] ... |
[INFO] [stderr] 1380 | | ///
[INFO] [stderr] 1381 | | /// Can return an error if the database connection is lost.
[INFO] [stderr] | |_______________________________________________________________^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db.rs:1393:5
[INFO] [stderr] |
[INFO] [stderr] 1393 | / /// Deletes all rows that match the given query.
[INFO] [stderr] 1394 | | ///
[INFO] [stderr] 1395 | | /// # Errors
[INFO] [stderr] 1396 | | ///
[INFO] [stderr] ... |
[INFO] [stderr] 1402 | | ///
[INFO] [stderr] 1403 | | /// Can return an error if the database connection is lost.
[INFO] [stderr] | |_______________________________________________________________^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db.rs:1589:1
[INFO] [stderr] |
[INFO] [stderr] 1589 | / /// A trait that provides a backend for the database.
[INFO] [stderr] 1590 | | ///
[INFO] [stderr] 1591 | | /// This trait is used to provide a backend for the database.
[INFO] [stderr] | |_____________________________________________________________^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db.rs:1595:5
[INFO] [stderr] |
[INFO] [stderr] 1595 | / /// Inserts a new row into the database, or updates an existing row if it
[INFO] [stderr] 1596 | | /// already exists.
[INFO] [stderr] 1597 | | ///
[INFO] [stderr] 1598 | | /// # Errors
[INFO] [stderr] ... |
[INFO] [stderr] 1601 | | /// the database, for instance because the migrations haven't been
[INFO] [stderr] 1602 | | /// applied, or there was a problem with the database connection.
[INFO] [stderr] | |_____________________________________________________________________^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db.rs:1605:5
[INFO] [stderr] |
[INFO] [stderr] 1605 | / /// Inserts a new row into the database.
[INFO] [stderr] 1606 | | ///
[INFO] [stderr] 1607 | | /// # Errors
[INFO] [stderr] 1608 | | ///
[INFO] [stderr] 1609 | | /// This method can return an error if the row could not be inserted into
[INFO] [stderr] 1610 | | /// the database, for instance because the migrations haven't been
[INFO] [stderr] 1611 | | /// applied, or there was a problem with the database connection.
[INFO] [stderr] | |_____________________________________________________________________^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db.rs:1614:5
[INFO] [stderr] |
[INFO] [stderr] 1614 | / /// Updates an existing row in the database.
[INFO] [stderr] 1615 | | ///
[INFO] [stderr] 1616 | | /// # Errors
[INFO] [stderr] 1617 | | ///
[INFO] [stderr] 1618 | | /// This method can return an error if the row could not be updated in the
[INFO] [stderr] 1619 | | /// database, for instance because the migrations haven't been applied, or
[INFO] [stderr] 1620 | | /// there was a problem with the database connection.
[INFO] [stderr] | |_________________________________________________________^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db.rs:1623:5
[INFO] [stderr] |
[INFO] [stderr] 1623 | / /// Bulk inserts multiple rows into the database.
[INFO] [stderr] 1624 | | ///
[INFO] [stderr] 1625 | | /// # Errors
[INFO] [stderr] 1626 | | ///
[INFO] [stderr] 1627 | | /// This method can return an error if the rows could not be inserted into
[INFO] [stderr] 1628 | | /// the database, for instance because the migrations haven't been
[INFO] [stderr] 1629 | | /// applied, or there was a problem with the database connection.
[INFO] [stderr] | |_____________________________________________________________________^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db.rs:1632:5
[INFO] [stderr] |
[INFO] [stderr] 1632 | / /// Bulk inserts multiple rows into the database, or updates existing rows
[INFO] [stderr] 1633 | | /// if they already exist.
[INFO] [stderr] 1634 | | ///
[INFO] [stderr] 1635 | | /// # Errors
[INFO] [stderr] ... |
[INFO] [stderr] 1638 | | /// the database, for instance because the migrations haven't been
[INFO] [stderr] 1639 | | /// applied, or there was a problem with the database connection.
[INFO] [stderr] | |_____________________________________________________________________^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db.rs:1642:5
[INFO] [stderr] |
[INFO] [stderr] 1642 | / /// Executes a query and returns the results converted to the model type.
[INFO] [stderr] 1643 | | ///
[INFO] [stderr] 1644 | | /// # Errors
[INFO] [stderr] 1645 | | ///
[INFO] [stderr] ... |
[INFO] [stderr] 1651 | | ///
[INFO] [stderr] 1652 | | /// Can return an error if the database connection is lost.
[INFO] [stderr] | |_______________________________________________________________^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db.rs:1655:5
[INFO] [stderr] |
[INFO] [stderr] 1655 | / /// Returns the first row that matches the given query. If no rows match the
[INFO] [stderr] 1656 | | /// query, returns `None`.
[INFO] [stderr] 1657 | | ///
[INFO] [stderr] 1658 | | /// # Errors
[INFO] [stderr] ... |
[INFO] [stderr] 1665 | | ///
[INFO] [stderr] 1666 | | /// Can return an error if the database connection is lost.
[INFO] [stderr] | |_______________________________________________________________^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db.rs:1669:5
[INFO] [stderr] |
[INFO] [stderr] 1669 | / /// Returns whether a row exists that matches the given query.
[INFO] [stderr] 1670 | | ///
[INFO] [stderr] 1671 | | /// # Errors
[INFO] [stderr] 1672 | | ///
[INFO] [stderr] ... |
[INFO] [stderr] 1678 | | ///
[INFO] [stderr] 1679 | | /// Can return an error if the database connection is lost.
[INFO] [stderr] | |_______________________________________________________________^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db.rs:1682:5
[INFO] [stderr] |
[INFO] [stderr] 1682 | / /// Deletes all rows that match the given query.
[INFO] [stderr] 1683 | | ///
[INFO] [stderr] 1684 | | /// # Errors
[INFO] [stderr] 1685 | | ///
[INFO] [stderr] ... |
[INFO] [stderr] 1691 | | ///
[INFO] [stderr] 1692 | | /// Can return an error if the database connection is lost.
[INFO] [stderr] | |_______________________________________________________________^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db.rs:1735:1
[INFO] [stderr] |
[INFO] [stderr] 1735 | /// Result of a statement execution.
[INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db.rs:1742:1
[INFO] [stderr] |
[INFO] [stderr] 1742 | / impl StatementResult {
[INFO] [stderr] 1743 | | /// Creates a new statement result with the given number of rows affected.
[INFO] [stderr] 1744 | | #[must_use]
[INFO] [stderr] 1745 | | #[cfg(test)]
[INFO] [stderr] ... |
[INFO] [stderr] 1764 | | }
[INFO] [stderr] | |_^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db.rs:1753:5
[INFO] [stderr] |
[INFO] [stderr] 1753 | /// Returns the number of rows affected by the query.
[INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db.rs:1759:5
[INFO] [stderr] |
[INFO] [stderr] 1759 | /// Returns the ID of the last inserted row.
[INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db.rs:1766:1
[INFO] [stderr] |
[INFO] [stderr] 1766 | /// A structure that holds the number of rows.
[INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db.rs:1820:1
[INFO] [stderr] |
[INFO] [stderr] 1820 | / impl<T> Auto<T> {
[INFO] [stderr] 1821 | | /// Creates a new `Auto` instance that is automatically generated by the
[INFO] [stderr] 1822 | | /// database.
[INFO] [stderr] 1823 | | ///
[INFO] [stderr] ... |
[INFO] [stderr] 1901 | | }
[INFO] [stderr] | |_^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db.rs:1973:1
[INFO] [stderr] |
[INFO] [stderr] 1973 | / /// An error returned by [`LimitedString::new`] when the string is longer than
[INFO] [stderr] 1974 | | /// the specified limit.
[INFO] [stderr] | |________________________^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/db.rs:1981:1
[INFO] [stderr] |
[INFO] [stderr] 1981 | / impl<const LIMIT: u32> LimitedString<LIMIT> {
[INFO] [stderr] 1982 | | /// Creates a new [`LimitedString`] instance.
[INFO] [stderr] 1983 | | ///
[INFO] [stderr] 1984 | | /// # Errors
[INFO] [stderr] ... |
[INFO] [stderr] 2007 | | }
[INFO] [stderr] | |_^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/error/handler.rs:54:5
[INFO] [stderr] |
[INFO] [stderr] 54 | / /// Handles an error request and returns a response.
[INFO] [stderr] 55 | | ///
[INFO] [stderr] 56 | | /// This method is called when an error occurs and the application needs to
[INFO] [stderr] 57 | | /// generate an error page response.
[INFO] [stderr] ... |
[INFO] [stderr] 62 | | /// response. In this case, the error will be logged and a generic
[INFO] [stderr] 63 | | /// error page will be returned to the user.
[INFO] [stderr] | |________________________________________________^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/error/handler.rs:74:1
[INFO] [stderr] |
[INFO] [stderr] 74 | / /// A type-erased wrapper around an error page handler.
[INFO] [stderr] 75 | | ///
[INFO] [stderr] 76 | | /// This struct allows storing different types of error page handlers in a
[INFO] [stderr] 77 | | /// homogeneous collection or service. It implements [`Clone`] and can be
[INFO] [stderr] 78 | | /// used with Cot's error handling infrastructure.
[INFO] [stderr] | |__________________________________________________^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/error/handler.rs:85:1
[INFO] [stderr] |
[INFO] [stderr] 85 | / impl DynErrorPageHandler {
[INFO] [stderr] 86 | | /// Creates a new `DynErrorPageHandler` from a concrete error page handler.
[INFO] [stderr] 87 | | ///
[INFO] [stderr] 88 | | /// This method wraps a concrete error page handler in a type-erased
[INFO] [stderr] ... |
[INFO] [stderr] 132 | | }
[INFO] [stderr] | |_^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/error/handler.rs:178:1
[INFO] [stderr] |
[INFO] [stderr] 178 | / /// A wrapper around [`Error`] that contains an error (outermost,
[INFO] [stderr] 179 | | /// possibly middleware-wrapped) to be processed by the error handler.
[INFO] [stderr] 180 | | ///
[INFO] [stderr] 181 | | /// This returns the outermost error returned by the request handler and
[INFO] [stderr] ... |
[INFO] [stderr] 185 | | /// check for specific error types even when middleware might have wrapped the
[INFO] [stderr] 186 | | /// error.
[INFO] [stderr] | |__________^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/error/handler.rs:190:1
[INFO] [stderr] |
[INFO] [stderr] 190 | / impl RequestOuterError {
[INFO] [stderr] 191 | | #[must_use]
[INFO] [stderr] 192 | | pub(crate) fn new(error: Error) -> Self {
[INFO] [stderr] 193 | | Self(Arc::new(error))
[INFO] [stderr] 194 | | }
[INFO] [stderr] 195 | | }
[INFO] [stderr] | |_^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/error/handler.rs:221:1
[INFO] [stderr] |
[INFO] [stderr] 221 | / /// A wrapper around [`Error`] that contains an error to be processed by the
[INFO] [stderr] 222 | | /// error handler.
[INFO] [stderr] 223 | | ///
[INFO] [stderr] 224 | | /// Note that the [`Deref`] implementation returns the inner [`Error`] (see
[INFO] [stderr] ... |
[INFO] [stderr] 228 | | /// wrapped the error. If you need to access the outermost error instead,
[INFO] [stderr] 229 | | /// you can use [`RequestOuterError`].
[INFO] [stderr] | |______________________________________^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/form/fields.rs:35:17
[INFO] [stderr] |
[INFO] [stderr] 35 | #[doc = concat!("A form field for ", $purpose, ".")]
[INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] ...
[INFO] [stderr] 73 | impl_form_field!(StringField, StringFieldOptions, "a string");
[INFO] [stderr] | ------------------------------------------------------------- in this macro invocation
[INFO] [stderr] |
[INFO] [stderr] = note: this warning originates in the macro `impl_form_field` (in Nightly builds, run with -Z macro-backtrace for more info)
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/form/fields.rs:75:1
[INFO] [stderr] |
[INFO] [stderr] 75 | /// Custom options for a [`StringField`].
[INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/form/fields.rs:35:17
[INFO] [stderr] |
[INFO] [stderr] 35 | #[doc = concat!("A form field for ", $purpose, ".")]
[INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] ...
[INFO] [stderr] 143 | impl_form_field!(PasswordField, PasswordFieldOptions, "a password");
[INFO] [stderr] | ------------------------------------------------------------------- in this macro invocation
[INFO] [stderr] |
[INFO] [stderr] = note: this warning originates in the macro `impl_form_field` (in Nightly builds, run with -Z macro-backtrace for more info)
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/form/fields.rs:145:1
[INFO] [stderr] |
[INFO] [stderr] 145 | /// Custom options for a [`PasswordField`].
[INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/form/fields.rs:35:17
[INFO] [stderr] |
[INFO] [stderr] 35 | #[doc = concat!("A form field for ", $purpose, ".")]
[INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] ...
[INFO] [stderr] 218 | impl_form_field!(EmailField, EmailFieldOptions, "an email");
[INFO] [stderr] | ----------------------------------------------------------- in this macro invocation
[INFO] [stderr] |
[INFO] [stderr] = note: this warning originates in the macro `impl_form_field` (in Nightly builds, run with -Z macro-backtrace for more info)
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/form/fields.rs:220:1
[INFO] [stderr] |
[INFO] [stderr] 220 | /// Custom options for [`EmailField`]
[INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/form/fields.rs:35:17
[INFO] [stderr] |
[INFO] [stderr] 35 | #[doc = concat!("A form field for ", $purpose, ".")]
[INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] ...
[INFO] [stderr] 293 | impl_form_field!(IntegerField, IntegerFieldOptions, "an integer", T: Integer);
[INFO] [stderr] | ----------------------------------------------------------------------------- in this macro invocation
[INFO] [stderr] |
[INFO] [stderr] = note: this warning originates in the macro `impl_form_field` (in Nightly builds, run with -Z macro-backtrace for more info)
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/form/fields.rs:295:1
[INFO] [stderr] |
[INFO] [stderr] 295 | /// Custom options for a [`IntegerField`].
[INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/form/fields.rs:35:17
[INFO] [stderr] |
[INFO] [stderr] 35 | #[doc = concat!("A form field for ", $purpose, ".")]
[INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] ...
[INFO] [stderr] 465 | impl_form_field!(BoolField, BoolFieldOptions, "a boolean");
[INFO] [stderr] | ---------------------------------------------------------- in this macro invocation
[INFO] [stderr] |
[INFO] [stderr] = note: this warning originates in the macro `impl_form_field` (in Nightly builds, run with -Z macro-backtrace for more info)
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/form/fields.rs:467:1
[INFO] [stderr] |
[INFO] [stderr] 467 | /// Custom options for a [`BoolField`].
[INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/form/fields.rs:35:17
[INFO] [stderr] |
[INFO] [stderr] 35 | #[doc = concat!("A form field for ", $purpose, ".")]
[INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] ...
[INFO] [stderr] 650 | impl_form_field!(FloatField, FloatFieldOptions, "a float", T: Float);
[INFO] [stderr] | --------------------------------------------------------------------- in this macro invocation
[INFO] [stderr] |
[INFO] [stderr] = note: this warning originates in the macro `impl_form_field` (in Nightly builds, run with -Z macro-backtrace for more info)
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/form/fields.rs:652:1
[INFO] [stderr] |
[INFO] [stderr] 652 | /// Custom options for a [`FloatField`].
[INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/form/fields.rs:697:1
[INFO] [stderr] |
[INFO] [stderr] 697 | / /// A trait for types that can be represented as a float.
[INFO] [stderr] 698 | | ///
[INFO] [stderr] 699 | | /// This trait is implemented for `f32` and `f64`.
[INFO] [stderr] | |__________________________________________________^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/form/fields.rs:35:17
[INFO] [stderr] |
[INFO] [stderr] 35 | #[doc = concat!("A form field for ", $purpose, ".")]
[INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] ...
[INFO] [stderr] 777 | impl_form_field!(UrlField, UrlFieldOptions, "a URL");
[INFO] [stderr] | ---------------------------------------------------- in this macro invocation
[INFO] [stderr] |
[INFO] [stderr] = note: this warning originates in the macro `impl_form_field` (in Nightly builds, run with -Z macro-backtrace for more info)
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/form/fields.rs:779:1
[INFO] [stderr] |
[INFO] [stderr] 779 | /// Custom options for a [`UrlField`].
[INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/form.rs:69:1
[INFO] [stderr] |
[INFO] [stderr] 69 | /// Error occurred while processing a form.
[INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/form.rs:93:1
[INFO] [stderr] |
[INFO] [stderr] 93 | / /// The result of validating a form.
[INFO] [stderr] 94 | | ///
[INFO] [stderr] 95 | | /// This enum is used to represent the result of validating a form. In the case
[INFO] [stderr] 96 | | /// of a successful validation, the `Ok` variant contains the form object. In
[INFO] [stderr] 97 | | /// the case of a failed validation, the `ValidationError` variant contains the
[INFO] [stderr] 98 | | /// context object with the validation errors, as well as the user's input.
[INFO] [stderr] | |___________________________________________________________________________^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/form.rs:108:1
[INFO] [stderr] |
[INFO] [stderr] 108 | / impl<T: Form> FormResult<T> {
[INFO] [stderr] 109 | | /// Unwraps the form result, panicking if the form validation failed.
[INFO] [stderr] 110 | | ///
[INFO] [stderr] 111 | | /// This should only be used in tests or in cases where the form validation
[INFO] [stderr] ... |
[INFO] [stderr] 124 | | }
[INFO] [stderr] | |_^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/form.rs:109:5
[INFO] [stderr] |
[INFO] [stderr] 109 | / /// Unwraps the form result, panicking if the form validation failed.
[INFO] [stderr] 110 | | ///
[INFO] [stderr] 111 | | /// This should only be used in tests or in cases where the form validation
[INFO] [stderr] 112 | | /// is guaranteed to pass.
[INFO] [stderr] ... |
[INFO] [stderr] 115 | | ///
[INFO] [stderr] 116 | | /// Panics if the form validation failed.
[INFO] [stderr] | |_____________________________________________^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/form.rs:126:1
[INFO] [stderr] |
[INFO] [stderr] 126 | /// An error that can occur when validating a form field.
[INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/form.rs:189:1
[INFO] [stderr] |
[INFO] [stderr] 189 | / impl FormFieldValidationError {
[INFO] [stderr] 190 | | /// Creates a new `FormFieldValidationError` for an invalid value of a
[INFO] [stderr] 191 | | /// field.
[INFO] [stderr] 192 | | #[must_use]
[INFO] [stderr] ... |
[INFO] [stderr] 253 | | }
[INFO] [stderr] | |_^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/form.rs:190:5
[INFO] [stderr] |
[INFO] [stderr] 190 | / /// Creates a new `FormFieldValidationError` for an invalid value of a
[INFO] [stderr] 191 | | /// field.
[INFO] [stderr] | |______________^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/form.rs:197:5
[INFO] [stderr] |
[INFO] [stderr] 197 | / /// Creates a new `FormFieldValidationError` for a field value that is too
[INFO] [stderr] 198 | | /// long.
[INFO] [stderr] | |_____________^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/form.rs:204:5
[INFO] [stderr] |
[INFO] [stderr] 204 | / /// Creates a new `FormFieldValidationError` for a field value that is too
[INFO] [stderr] 205 | | /// short.
[INFO] [stderr] | |______________^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/form.rs:211:5
[INFO] [stderr] |
[INFO] [stderr] 211 | / /// Creates a new `FormFieldValidatorError`for a field value below the
[INFO] [stderr] 212 | | /// permitted minimum value.
[INFO] [stderr] | |________________________________^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/form.rs:220:5
[INFO] [stderr] |
[INFO] [stderr] 220 | / /// Creates a new `FormFieldValidationError` for a field value that exceeds
[INFO] [stderr] 221 | | /// the permitted maximum value
[INFO] [stderr] | |___________________________________^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/form.rs:229:5
[INFO] [stderr] |
[INFO] [stderr] 229 | /// Creates a new `FormFieldValidationError` for an ambiguous datetime.
[INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/form.rs:235:5
[INFO] [stderr] |
[INFO] [stderr] 235 | / /// Creates a new `FormFieldValidationError` for a non-existent local
[INFO] [stderr] 236 | | /// datetime.
[INFO] [stderr] | |_________________^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/form.rs:242:5
[INFO] [stderr] |
[INFO] [stderr] 242 | /// Creates a new `FormFieldValidationError` from a `String`.
[INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/form.rs:248:5
[INFO] [stderr] |
[INFO] [stderr] 248 | /// Creates a new `FormFieldValidationError` from a static string.
[INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/form.rs:255:1
[INFO] [stderr] |
[INFO] [stderr] 255 | /// An enum indicating the target of a form validation error.
[INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/form.rs:296:5
[INFO] [stderr] |
[INFO] [stderr] 296 | / /// Creates a form struct from a request.
[INFO] [stderr] 297 | | ///
[INFO] [stderr] 298 | | /// # Errors
[INFO] [stderr] 299 | | ///
[INFO] [stderr] 300 | | /// This method should return an error if the form data could not be read
[INFO] [stderr] 301 | | /// from the request.
[INFO] [stderr] | |_________________________^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/form.rs:304:5
[INFO] [stderr] |
[INFO] [stderr] 304 | / /// Creates the context for the form from `self`.
[INFO] [stderr] 305 | | ///
[INFO] [stderr] 306 | | /// This is useful for pre-populating forms with objects created in the code
[INFO] [stderr] 307 | | /// or obtained externally, such as from a database.
[INFO] [stderr] | |________________________________________________________^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/form.rs:310:5
[INFO] [stderr] |
[INFO] [stderr] 310 | / /// Builds the context for the form from a request.
[INFO] [stderr] 311 | | ///
[INFO] [stderr] 312 | | /// Note that this doesn't try to convert the values from the form fields
[INFO] [stderr] 313 | | /// into the final types, so this context object may not include all the
[INFO] [stderr] ... |
[INFO] [stderr] 318 | | /// This method should return an error if the form data could not be read
[INFO] [stderr] 319 | | /// from the request.
[INFO] [stderr] | |_________________________^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/form.rs:462:1
[INFO] [stderr] |
[INFO] [stderr] 462 | / /// A trait for form contexts.
[INFO] [stderr] 463 | | ///
[INFO] [stderr] 464 | | /// A form context is used to store the state of a form, such as the values of
[INFO] [stderr] 465 | | /// the fields and any errors that occur during validation. This trait is used
[INFO] [stderr] ... |
[INFO] [stderr] 470 | | /// implementations are generated automatically through the
[INFO] [stderr] 471 | | /// [`Form`](derive@Form) derive macro.
[INFO] [stderr] | |_______________________________________^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/form.rs:474:5
[INFO] [stderr] |
[INFO] [stderr] 474 | /// Creates a new form context without any initial form data.
[INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/form.rs:479:5
[INFO] [stderr] |
[INFO] [stderr] 479 | /// Returns an iterator over the fields in the form.
[INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/form.rs:482:5
[INFO] [stderr] |
[INFO] [stderr] 482 | / /// Sets the value of a form field.
[INFO] [stderr] 483 | | ///
[INFO] [stderr] 484 | | /// # Errors
[INFO] [stderr] 485 | | ///
[INFO] [stderr] 486 | | /// This method should return an error if the value is invalid.
[INFO] [stderr] | |___________________________________________________________________^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/form.rs:493:5
[INFO] [stderr] |
[INFO] [stderr] 493 | /// Adds a validation error to the form context.
[INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/form.rs:498:5
[INFO] [stderr] |
[INFO] [stderr] 498 | /// Returns the validation errors for a target in the form context.
[INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/form.rs:501:5
[INFO] [stderr] |
[INFO] [stderr] 501 | / /// Returns a mutable reference to the validation errors for a target in the
[INFO] [stderr] 502 | | /// form context.
[INFO] [stderr] | |_____________________^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/form.rs:506:5
[INFO] [stderr] |
[INFO] [stderr] 506 | /// Returns whether the form context has any validation errors.
[INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/form.rs:510:1
[INFO] [stderr] |
[INFO] [stderr] 510 | /// Generic options valid for all types of form fields.
[INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/form.rs:524:1
[INFO] [stderr] |
[INFO] [stderr] 524 | / /// A form field.
[INFO] [stderr] 525 | | ///
[INFO] [stderr] 526 | | /// This trait is used to define a type of field that can be used in a form. It
[INFO] [stderr] 527 | | /// is used to render the field in an HTML form, set the value of the field, and
[INFO] [stderr] 528 | | /// validate it. Typically, the implementors of this trait are used indirectly
[INFO] [stderr] 529 | | /// through the [`Form`] trait and field types that implement [`AsFormField`].
[INFO] [stderr] | |______________________________________________________________________________^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/form.rs:534:5
[INFO] [stderr] |
[INFO] [stderr] 534 | /// Creates a new form field with the given options.
[INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/form.rs:539:5
[INFO] [stderr] |
[INFO] [stderr] 539 | /// Returns the generic options for the form field.
[INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/form.rs:542:5
[INFO] [stderr] |
[INFO] [stderr] 542 | /// Returns the ID of the form field.
[INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/form.rs:547:5
[INFO] [stderr] |
[INFO] [stderr] 547 | /// Returns the display name of the form field.
[INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/form.rs:552:5
[INFO] [stderr] |
[INFO] [stderr] 552 | /// Returns the string value of the form field.
[INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/form.rs:555:5
[INFO] [stderr] |
[INFO] [stderr] 555 | / /// Sets the value of the form field.
[INFO] [stderr] 556 | | ///
[INFO] [stderr] 557 | | /// This method should convert the value to the appropriate type for the
[INFO] [stderr] 558 | | /// field, such as a number for a number field.
[INFO] [stderr] ... |
[INFO] [stderr] 563 | | /// does not support storing multiple values, it should overwrite the
[INFO] [stderr] 564 | | /// previous value.
[INFO] [stderr] | |_______________________^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/form.rs:571:1
[INFO] [stderr] |
[INFO] [stderr] 571 | / /// A version of [`FormField`] that can be used in a dynamic context.
[INFO] [stderr] 572 | | ///
[INFO] [stderr] 573 | | /// This trait is used to allow a form field to be used in a dynamic context,
[INFO] [stderr] 574 | | /// such as when using Form field iterator. It provides access to the field's
[INFO] [stderr] 575 | | /// options, value, and rendering, among others.
[INFO] [stderr] 576 | | ///
[INFO] [stderr] 577 | | /// This trait is implemented for all types that implement [`FormField`].
[INFO] [stderr] | |_________________________________________________________________________^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/form.rs:580:5
[INFO] [stderr] |
[INFO] [stderr] 580 | /// Returns the generic options for the form field.
[INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/form.rs:583:5
[INFO] [stderr] |
[INFO] [stderr] 583 | /// Returns the HTML ID of the form field.
[INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/form.rs:586:5
[INFO] [stderr] |
[INFO] [stderr] 586 | / /// Returns the string value of the form field if any has been set (and
[INFO] [stderr] 587 | | /// makes sense for the field type).
[INFO] [stderr] | |________________________________________^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/form.rs:590:5
[INFO] [stderr] |
[INFO] [stderr] 590 | /// Sets the value of the form field.
[INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/form.rs:617:1
[INFO] [stderr] |
[INFO] [stderr] 617 | / /// A trait for types that can be used as form fields.
[INFO] [stderr] 618 | | ///
[INFO] [stderr] 619 | | /// This trait uses [`FormField`] to define a type that can be used as a form
[INFO] [stderr] 620 | | /// field. It provides a way to clean the value of the field, which is used to
[INFO] [stderr] 621 | | /// validate the field's value before converting to the final type.
[INFO] [stderr] | |___________________________________________________________________^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/form.rs:626:5
[INFO] [stderr] |
[INFO] [stderr] 626 | / /// Creates a new form field with the given options and custom options.
[INFO] [stderr] 627 | | ///
[INFO] [stderr] 628 | | /// This method is used to create a new instance of the form field with the
[INFO] [stderr] 629 | | /// given options and custom options. The options are used to set the
[INFO] [stderr] ... |
[INFO] [stderr] 633 | | /// The custom options are unique to each field type and are used to set
[INFO] [stderr] 634 | | /// additional properties of the field.
[INFO] [stderr] | |___________________________________________^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/form.rs:642:5
[INFO] [stderr] |
[INFO] [stderr] 642 | / /// Validates the value of the field and converts it to the final type. This
[INFO] [stderr] 643 | | /// method should return an error if the value is invalid.
[INFO] [stderr] 644 | | ///
[INFO] [stderr] 645 | | /// # Errors
[INFO] [stderr] 646 | | ///
[INFO] [stderr] 647 | | /// Returns an error if the value fails to validate or convert to the final
[INFO] [stderr] 648 | | /// type
[INFO] [stderr] | |____________^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/form.rs:653:5
[INFO] [stderr] |
[INFO] [stderr] 653 | /// Returns `self` as a value that can be set with [`FormField::set_value`].
[INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/admin.rs:149:1
[INFO] [stderr] |
[INFO] [stderr] 149 | /// Struct representing the pagination of objects.
[INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/admin.rs:156:1
[INFO] [stderr] |
[INFO] [stderr] 156 | / impl Pagination {
[INFO] [stderr] 157 | | fn new(limit: u64, page: u64) -> Self {
[INFO] [stderr] 158 | | assert!(page > 0, "Page number must be greater than 0");
[INFO] [stderr] ... |
[INFO] [stderr] 177 | | }
[INFO] [stderr] | |_^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/admin.rs:166:5
[INFO] [stderr] |
[INFO] [stderr] 166 | /// Returns the limit of objects per page.
[INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/admin.rs:172:5
[INFO] [stderr] |
[INFO] [stderr] 172 | /// Returns the offset of objects.
[INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/admin.rs:397:1
[INFO] [stderr] |
[INFO] [stderr] 397 | / /// A trait for adding admin models to the app.
[INFO] [stderr] 398 | | ///
[INFO] [stderr] 399 | | /// This exposes an API over [`AdminModel`] that is dyn-compatible and
[INFO] [stderr] 400 | | /// hence can be dynamically added to the project.
[INFO] [stderr] 401 | | ///
[INFO] [stderr] 402 | | /// See [`DefaultAdminModelManager`] for an automatic implementation of this
[INFO] [stderr] 403 | | /// trait.
[INFO] [stderr] | |__________^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/admin.rs:406:5
[INFO] [stderr] |
[INFO] [stderr] 406 | /// Returns the display name of the model.
[INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/admin.rs:409:5
[INFO] [stderr] |
[INFO] [stderr] 409 | /// Returns the URL slug for the model.
[INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/admin.rs:412:5
[INFO] [stderr] |
[INFO] [stderr] 412 | /// Returns the list of objects of this model.
[INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/admin.rs:419:5
[INFO] [stderr] |
[INFO] [stderr] 419 | /// Returns the total count of objects of this model.
[INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/admin.rs:422:5
[INFO] [stderr] |
[INFO] [stderr] 422 | /// Returns the object with the given ID.
[INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/admin.rs:429:5
[INFO] [stderr] |
[INFO] [stderr] 429 | /// Returns an empty form context for this model.
[INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/admin.rs:432:5
[INFO] [stderr] |
[INFO] [stderr] 432 | / /// Returns a form context pre-filled with the data from given object.
[INFO] [stderr] 433 | | ///
[INFO] [stderr] 434 | | /// It is guaranteed that `object` parameter is an object returned by either
[INFO] [stderr] 435 | | /// [`Self::get_objects`] or [`Self::get_object_by_id`] methods. This means
[INFO] [stderr] 436 | | /// that if you always return the same object type from these methods,
[INFO] [stderr] 437 | | /// you can safely downcast the object to the same type in this method
[INFO] [stderr] 438 | | /// as well.
[INFO] [stderr] | |________________^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/admin.rs:441:5
[INFO] [stderr] |
[INFO] [stderr] 441 | / /// Saves the object by using the form data from given request.
[INFO] [stderr] 442 | | ///
[INFO] [stderr] 443 | | /// # Errors
[INFO] [stderr] 444 | | ///
[INFO] [stderr] 445 | | /// Returns an error if the object could not be saved, for instance
[INFO] [stderr] 446 | | /// due to a database error.
[INFO] [stderr] | |________________________________^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/admin.rs:453:5
[INFO] [stderr] |
[INFO] [stderr] 453 | / /// Removes the object with the given ID.
[INFO] [stderr] 454 | | ///
[INFO] [stderr] 455 | | /// # Errors
[INFO] [stderr] 456 | | ///
[INFO] [stderr] ... |
[INFO] [stderr] 459 | | /// Returns an error if the object could not be removed, for instance
[INFO] [stderr] 460 | | /// due to a database error.
[INFO] [stderr] | |________________________________^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/admin.rs:464:1
[INFO] [stderr] |
[INFO] [stderr] 464 | /// A default implementation of [`AdminModelManager`] for an [`AdminModel`].
[INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/admin.rs:476:1
[INFO] [stderr] |
[INFO] [stderr] 476 | / impl<T> DefaultAdminModelManager<T> {
[INFO] [stderr] 477 | | /// Creates a new instance of the default admin model manager.
[INFO] [stderr] 478 | | #[must_use]
[INFO] [stderr] 479 | | pub const fn new() -> Self {
[INFO] [stderr] ... |
[INFO] [stderr] 484 | | }
[INFO] [stderr] | |_^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/admin.rs:477:5
[INFO] [stderr] |
[INFO] [stderr] 477 | /// Creates a new instance of the default admin model manager.
[INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/admin.rs:549:1
[INFO] [stderr] |
[INFO] [stderr] 549 | /// A model that can be managed by the admin panel.
[INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/admin.rs:557:5
[INFO] [stderr] |
[INFO] [stderr] 557 | /// Get the objects of this model.
[INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/admin.rs:562:5
[INFO] [stderr] |
[INFO] [stderr] 562 | /// Get the total count of objects of this model.
[INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/admin.rs:567:5
[INFO] [stderr] |
[INFO] [stderr] 567 | /// Returns the object with the given ID.
[INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/admin.rs:572:5
[INFO] [stderr] |
[INFO] [stderr] 572 | /// Get the display name of this model.
[INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/admin.rs:577:5
[INFO] [stderr] |
[INFO] [stderr] 577 | /// Get the URL slug for this model.
[INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/admin.rs:582:5
[INFO] [stderr] |
[INFO] [stderr] 582 | /// Get the ID of this model instance as a [`String`].
[INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/admin.rs:585:5
[INFO] [stderr] |
[INFO] [stderr] 585 | /// Get the display text of this model instance.
[INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/admin.rs:588:5
[INFO] [stderr] |
[INFO] [stderr] 588 | /// Get the form context for this model.
[INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/admin.rs:593:5
[INFO] [stderr] |
[INFO] [stderr] 593 | /// Get the form context with the data pre-filled from this model instance.
[INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/admin.rs:596:5
[INFO] [stderr] |
[INFO] [stderr] 596 | / /// Save the model instance from the form data in the request.
[INFO] [stderr] 597 | | ///
[INFO] [stderr] 598 | | /// # Errors
[INFO] [stderr] 599 | | ///
[INFO] [stderr] 600 | | /// Returns an error if the object could not be saved, for instance
[INFO] [stderr] 601 | | /// due to a database error.
[INFO] [stderr] | |________________________________^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/admin.rs:609:5
[INFO] [stderr] |
[INFO] [stderr] 609 | / /// Remove the model instance with the given ID.
[INFO] [stderr] 610 | | ///
[INFO] [stderr] 611 | | /// # Errors
[INFO] [stderr] 612 | | ///
[INFO] [stderr] ... |
[INFO] [stderr] 615 | | /// Returns an error if the object could not be removed, for instance
[INFO] [stderr] 616 | | /// due to a database error.
[INFO] [stderr] | |________________________________^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/admin.rs:647:1
[INFO] [stderr] |
[INFO] [stderr] 647 | / impl AdminApp {
[INFO] [stderr] 648 | | /// Creates an admin app instance.
[INFO] [stderr] 649 | | ///
[INFO] [stderr] 650 | | /// # Examples
[INFO] [stderr] ... |
[INFO] [stderr] 668 | | }
[INFO] [stderr] | |_^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/auth/db.rs:35:1
[INFO] [stderr] |
[INFO] [stderr] 35 | /// A user stored in the database.
[INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/auth/db.rs:37:1
[INFO] [stderr] |
[INFO] [stderr] 37 | #[model]
[INFO] [stderr] | ^^^^^^^^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/auth/db.rs:46:1
[INFO] [stderr] |
[INFO] [stderr] 46 | /// An error that occurs when creating a user.
[INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/auth/db.rs:55:1
[INFO] [stderr] |
[INFO] [stderr] 55 | / impl DatabaseUser {
[INFO] [stderr] 56 | | #[must_use]
[INFO] [stderr] 57 | | fn new(
[INFO] [stderr] 58 | | id: Auto<i64>,
[INFO] [stderr] ... |
[INFO] [stderr] 346 | | }
[INFO] [stderr] | |_^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/auth/db.rs:218:5
[INFO] [stderr] |
[INFO] [stderr] 218 | / /// Authenticate a user.
[INFO] [stderr] 219 | | ///
[INFO] [stderr] 220 | | /// # Errors
[INFO] [stderr] 221 | | ///
[INFO] [stderr] 222 | | /// Returns an error if there was an error querying the database.
[INFO] [stderr] | |_____________________________________________________________________^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/auth/db.rs:383:1
[INFO] [stderr] |
[INFO] [stderr] 383 | / /// Credentials for authenticating a user stored in the database.
[INFO] [stderr] 384 | | ///
[INFO] [stderr] 385 | | /// This struct is used to authenticate a user stored in the database. It
[INFO] [stderr] 386 | | /// contains the username and password of the user.
[INFO] [stderr] 387 | | ///
[INFO] [stderr] 388 | | /// Can be passed to [`Auth::authenticate`](crate::auth::Auth::authenticate) to
[INFO] [stderr] 389 | | /// authenticate a user when using the [`DatabaseUserBackend`].
[INFO] [stderr] | |_______________________________________________________________^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/auth/db.rs:396:1
[INFO] [stderr] |
[INFO] [stderr] 396 | / impl DatabaseUserCredentials {
[INFO] [stderr] 397 | | /// Create a new instance of the database user credentials.
[INFO] [stderr] 398 | | ///
[INFO] [stderr] 399 | | /// # Example
[INFO] [stderr] ... |
[INFO] [stderr] 446 | | }
[INFO] [stderr] | |_^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/auth/db.rs:448:1
[INFO] [stderr] |
[INFO] [stderr] 448 | / /// The authentication backend for users stored in the database.
[INFO] [stderr] 449 | | ///
[INFO] [stderr] 450 | | /// This is the default authentication backend for Cot. It authenticates
[INFO] [stderr] 451 | | /// users stored in the database using the [`DatabaseUser`] model.
[INFO] [stderr] 452 | | ///
[INFO] [stderr] 453 | | /// This backend supports authenticating users using the
[INFO] [stderr] 454 | | /// [`DatabaseUserCredentials`] struct and ignores all other credential types.
[INFO] [stderr] | |______________________________________________________________________________^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/auth/db.rs:460:1
[INFO] [stderr] |
[INFO] [stderr] 460 | / impl DatabaseUserBackend {
[INFO] [stderr] 461 | | /// Create a new instance of the database user authentication backend.
[INFO] [stderr] 462 | | ///
[INFO] [stderr] 463 | | /// # Example
[INFO] [stderr] ... |
[INFO] [stderr] 486 | | }
[INFO] [stderr] | |_^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/auth/db.rs:516:1
[INFO] [stderr] |
[INFO] [stderr] 516 | /// An app that provides authentication via a user model stored in the database.
[INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/auth/db.rs:526:1
[INFO] [stderr] |
[INFO] [stderr] 526 | / impl DatabaseUserApp {
[INFO] [stderr] 527 | | /// Create a new instance of the database user authentication app.
[INFO] [stderr] 528 | | ///
[INFO] [stderr] 529 | | /// # Example
[INFO] [stderr] ... |
[INFO] [stderr] 560 | | }
[INFO] [stderr] | |_^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/auth.rs:36:1
[INFO] [stderr] |
[INFO] [stderr] 36 | /// An error that occurs during authentication.
[INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/auth.rs:60:1
[INFO] [stderr] |
[INFO] [stderr] 60 | / impl AuthError {
[INFO] [stderr] 61 | | /// Creates a new [`AuthError::UserBackend`] error from a backend error.
[INFO] [stderr] 62 | | ///
[INFO] [stderr] 63 | | /// # Examples
[INFO] [stderr] ... |
[INFO] [stderr] 73 | | }
[INFO] [stderr] | |_^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/auth.rs:78:1
[INFO] [stderr] |
[INFO] [stderr] 78 | / /// A user object that can be authenticated.
[INFO] [stderr] 79 | | ///
[INFO] [stderr] 80 | | /// This trait is used to represent a user object that can be authenticated and
[INFO] [stderr] 81 | | /// is a core of the authentication system. A `User` object is returned by
[INFO] [stderr] ... |
[INFO] [stderr] 88 | | /// [`DatabaseUserBackend`](db::DatabaseUserBackend), which stores user data in
[INFO] [stderr] 89 | | /// the database using Cot ORM.
[INFO] [stderr] | |_______________________________^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/auth.rs:92:5
[INFO] [stderr] |
[INFO] [stderr] 92 | / /// Returns the user's ID.
[INFO] [stderr] 93 | | ///
[INFO] [stderr] 94 | | /// The ID is used to identify the user in the database or other storage.
[INFO] [stderr] 95 | | /// Can also be `None` if the user is not authenticated.
[INFO] [stderr] 96 | | ///
[INFO] [stderr] 97 | | /// [`AnonymousUser`] always returns `None`.
[INFO] [stderr] | |________________________________________________^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/auth.rs:102:5
[INFO] [stderr] |
[INFO] [stderr] 102 | / /// Returns the user's username.
[INFO] [stderr] 103 | | ///
[INFO] [stderr] 104 | | /// The username can be `None` if the user is not authenticated.
[INFO] [stderr] 105 | | ///
[INFO] [stderr] 106 | | /// [`AnonymousUser`] always returns `None`.
[INFO] [stderr] | |________________________________________________^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/auth.rs:114:5
[INFO] [stderr] |
[INFO] [stderr] 114 | / /// Returns whether the user is active.
[INFO] [stderr] 115 | | ///
[INFO] [stderr] 116 | | /// An active user is one that has been authenticated and is not banned or
[INFO] [stderr] 117 | | /// otherwise disabled. In other words, a user can be authenticated but
[INFO] [stderr] 118 | | /// unable to access the system.
[INFO] [stderr] 119 | | ///
[INFO] [stderr] 120 | | /// [`AnonymousUser`] always returns `false`.
[INFO] [stderr] | |_________________________________________________^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/auth.rs:125:5
[INFO] [stderr] |
[INFO] [stderr] 125 | / /// Returns whether the user is authenticated.
[INFO] [stderr] 126 | | ///
[INFO] [stderr] 127 | | /// An authenticated user is one that has been logged in and has an active
[INFO] [stderr] 128 | | /// session.
[INFO] [stderr] 129 | | ///
[INFO] [stderr] 130 | | /// [`AnonymousUser`] always returns `false`.
[INFO] [stderr] | |_________________________________________________^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/auth.rs:135:5
[INFO] [stderr] |
[INFO] [stderr] 135 | / /// Returns the user's last login time.
[INFO] [stderr] 136 | | ///
[INFO] [stderr] 137 | | /// This is the time when the user last logged in to the system. Can be
[INFO] [stderr] 138 | | /// [`None`] if the user has never logged in.
[INFO] [stderr] 139 | | ///
[INFO] [stderr] 140 | | /// [`AnonymousUser`] always returns [`None`].
[INFO] [stderr] | |__________________________________________________^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/auth.rs:145:5
[INFO] [stderr] |
[INFO] [stderr] 145 | / /// Returns the user's join time.
[INFO] [stderr] 146 | | ///
[INFO] [stderr] 147 | | /// This is the time when the user joined the system. Can be [`None`] if the
[INFO] [stderr] 148 | | /// user hasn't been authenticated.
[INFO] [stderr] 149 | | ///
[INFO] [stderr] 150 | | /// [`AnonymousUser`] always returns [`None`].
[INFO] [stderr] | |__________________________________________________^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/auth.rs:229:1
[INFO] [stderr] |
[INFO] [stderr] 229 | /// A user ID that uniquely identifies a user in a backend.
[INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/auth.rs:255:1
[INFO] [stderr] |
[INFO] [stderr] 255 | / impl UserId {
[INFO] [stderr] 256 | | /// Returns the user ID as an integer.
[INFO] [stderr] 257 | | ///
[INFO] [stderr] 258 | | /// Returns [`None`] if the user ID is not an integer.
[INFO] [stderr] ... |
[INFO] [stderr] 295 | | }
[INFO] [stderr] | |_^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/auth.rs:314:1
[INFO] [stderr] |
[INFO] [stderr] 314 | / /// An anonymous, unauthenticated user.
[INFO] [stderr] 315 | | ///
[INFO] [stderr] 316 | | /// This is used to represent a user that is not authenticated. It is returned
[INFO] [stderr] 317 | | /// by the [`Auth::user()`] method when there is no active user session.
[INFO] [stderr] | |________________________________________________________________________^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/auth.rs:396:1
[INFO] [stderr] |
[INFO] [stderr] 396 | / impl SessionAuthHash {
[INFO] [stderr] 397 | | /// Creates a new session authentication hash object from a byte slice.
[INFO] [stderr] 398 | | ///
[INFO] [stderr] 399 | | /// # Examples
[INFO] [stderr] ... |
[INFO] [stderr] 440 | | }
[INFO] [stderr] | |_^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/auth.rs:464:1
[INFO] [stderr] |
[INFO] [stderr] 464 | / /// A hashed password.
[INFO] [stderr] 465 | | ///
[INFO] [stderr] 466 | | /// This is used to store a hashed user password in the database. The password
[INFO] [stderr] 467 | | /// hash is created using the `password_auth` crate internally, so by default,
[INFO] [stderr] ... |
[INFO] [stderr] 476 | | /// be needed to compare password hashes directly. Instead, use the
[INFO] [stderr] 477 | | /// [`verify`](Self::verify) method to verify a password against the hash.
[INFO] [stderr] | |__________________________________________________________________________^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/auth.rs:482:1
[INFO] [stderr] |
[INFO] [stderr] 482 | / impl PasswordHash {
[INFO] [stderr] 483 | | /// Creates a new password hash object from a string.
[INFO] [stderr] 484 | | ///
[INFO] [stderr] 485 | | /// Note that this method takes the hash directly. If you need to hash a
[INFO] [stderr] ... |
[INFO] [stderr] 625 | | }
[INFO] [stderr] | |_^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/auth.rs:635:1
[INFO] [stderr] |
[INFO] [stderr] 635 | /// The result returned by [`PasswordHash::verify()`].
[INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr]
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr] --> src/auth.rs:694:1
[INFO] [stderr] |
[INFO] [stderr] 694 | / /// Authentication helper structure.
[INFO] [stderr] 695 | | ///
[WARN] too much data in the log, truncating it