pgrx 0.11.4

pgrx: A Rust framework for creating Postgres extensions
Documentation
Build #1195220 2024-04-19T12:07:13.772262+00:00
# rustc version
rustc 1.79.0-nightly (e3181b091 2024-04-18)# docs.rs version
docsrs 0.6.0 (bc86a4d3 2024-04-17)# build log
[INFO] running `Command { std: "docker" "create" "-v" "/home/cratesfyi/workspace/builds/pgrx-0.11.4/target:/opt/rustwide/target:rw,Z" "-v" "/home/cratesfyi/workspace/builds/pgrx-0.11.4/source:/opt/rustwide/workdir:ro,Z" "-v" "/home/cratesfyi/workspace/cargo-home:/opt/rustwide/cargo-home:ro,Z" "-v" "/home/cratesfyi/workspace/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:99613afd962a8cfa530ec1899472a458bd015a1ab0af876cf7eb06f6006d81ea" "/opt/rustwide/cargo-home/bin/cargo" "+nightly" "rustdoc" "--lib" "-Zrustdoc-map" "--features" "pg14 cshim" "--no-default-features" "--config" "build.rustflags=[\"--cfg\", \"docsrs\"]" "-Zhost-config" "-Ztarget-applies-to-host" "--config" "host.rustflags=[\"--cfg\", \"docsrs\"]" "--config" "build.rustdocflags=[\"--cfg\", \"docsrs\", \"-Z\", \"unstable-options\", \"--emit=invocation-specific\", \"--resource-suffix\", \"-20240418-1.79.0-nightly-e3181b091\", \"--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] 87f7c8cf80ad1109793bce692d97ccd38e5212b6ec1bd62f64bdb097d8b04a98
[INFO] running `Command { std: "docker" "start" "-a" "87f7c8cf80ad1109793bce692d97ccd38e5212b6ec1bd62f64bdb097d8b04a98", kill_on_drop: false }`
[INFO] [stderr] warning: target filter specified, but no targets matched; this is a no-op
[INFO] [stderr]  Documenting pgrx v0.11.4 (/opt/rustwide/workdir)
[INFO] [stderr] warning: unresolved link to `AddAssign`
[INFO] [stderr]   --> src/datum/numeric.rs:31:73
[INFO] [stderr]    |
[INFO] [stderr] 31 | /// It is [`AnyNumeric`] that also supports the various "Assign" (ie, [`AddAssign`]) traits.
[INFO] [stderr]    |                                                                         ^^^^^^^^^ no item named `AddAssign` in scope
[INFO] [stderr]    |
[INFO] [stderr]    = help: to escape `[` and `]` characters, add '\' before them like `\[` or `\]`
[INFO] [stderr]    = note: `#[warn(rustdoc::broken_intra_doc_links)]` on by default
[INFO] [stderr] 
[INFO] [stderr] warning: unresolved link to `TriggerTuple::Current`
[INFO] [stderr]    --> src/heap_tuple.rs:114:57
[INFO] [stderr]     |
[INFO] [stderr] 114 |     /// pgrx also invents the concept of a "current" ([`TriggerTuple::Current`]) tuple, which is either
[INFO] [stderr]     |                                                         ^^^^^^^^^^^^^^^^^^^^^ the enum `TriggerTuple` has no variant or associated item named `Current`
[INFO] [stderr] 
[INFO] [stderr] warning: unresolved link to `name`
[INFO] [stderr]   --> src/iter.rs:91:40
[INFO] [stderr]    |
[INFO] [stderr] 91 | /// must also be "named" using pgrx' [`name!`] macro.  See the examples below.
[INFO] [stderr]    |                                        ^^^^^ no item named `name` in scope
[INFO] [stderr]    |
[INFO] [stderr]    = note: `macro_rules` named `name` exists in this crate, but it is not in scope at this link's location
[INFO] [stderr] 
[INFO] [stderr] warning: unresolved link to `proretset`
[INFO] [stderr]    --> src/pg_catalog/pg_proc.rs:146:72
[INFO] [stderr]     |
[INFO] [stderr] 146 |     /// Estimated execution cost (in units of cpu_operator_cost); if [`proretset()`], this is cost per row
[INFO] [stderr]     |                                                                        ^^^^^^^^^^^ no item named `proretset` in scope
[INFO] [stderr]     |
[INFO] [stderr]     = help: to escape `[` and `]` characters, add '\' before them like `\[` or `\]`
[INFO] [stderr] 
[INFO] [stderr] warning: unresolved link to `proretset`
[INFO] [stderr]    --> src/pg_catalog/pg_proc.rs:153:56
[INFO] [stderr]     |
[INFO] [stderr] 153 |     /// Estimated number of result rows (zero if not [`proretset()`],)
[INFO] [stderr]     |                                                        ^^^^^^^^^^^ no item named `proretset` in scope
[INFO] [stderr]     |
[INFO] [stderr]     = help: to escape `[` and `]` characters, add '\' before them like `\[` or `\]`
[INFO] [stderr] 
[INFO] [stderr] warning: unresolved link to `Error::NoTupleTable`
[INFO] [stderr]    --> src/spi/tuple.rs:113:47
[INFO] [stderr]     |
[INFO] [stderr] 113 |     /// If we have no backing tuple table a [`Error::NoTupleTable`] is returned
[INFO] [stderr]     |                                               ^^^^^^^^^^^^^^^^^^^ no item named `Error` in scope
[INFO] [stderr] 
[INFO] [stderr] warning: unresolved link to `Error::NoTupleTable`
[INFO] [stderr]    --> src/spi/tuple.rs:146:47
[INFO] [stderr]     |
[INFO] [stderr] 146 |     /// If we have no backing tuple table a [`Error::NoTupleTable`] is returned
[INFO] [stderr]     |                                               ^^^^^^^^^^^^^^^^^^^ no item named `Error` in scope
[INFO] [stderr] 
[INFO] [stderr] warning: unresolved link to `Error::NoTupleTable`
[INFO] [stderr]    --> src/spi/tuple.rs:161:47
[INFO] [stderr]     |
[INFO] [stderr] 161 |     /// If we have no backing tuple table a [`Error::NoTupleTable`] is returned
[INFO] [stderr]     |                                               ^^^^^^^^^^^^^^^^^^^ no item named `Error` in scope
[INFO] [stderr] 
[INFO] [stderr] warning: unresolved link to `Error::NoTupleTable`
[INFO] [stderr]    --> src/spi/tuple.rs:188:47
[INFO] [stderr]     |
[INFO] [stderr] 188 |     /// If we have no backing tuple table a [`Error::NoTupleTable`] is returned
[INFO] [stderr]     |                                               ^^^^^^^^^^^^^^^^^^^ no item named `Error` in scope
[INFO] [stderr] 
[INFO] [stderr] warning: unresolved link to `Error::NoTupleTable`
[INFO] [stderr]    --> src/spi/tuple.rs:229:47
[INFO] [stderr]     |
[INFO] [stderr] 229 |     /// If we have no backing tuple table a [`Error::NoTupleTable`] is returned
[INFO] [stderr]     |                                               ^^^^^^^^^^^^^^^^^^^ no item named `Error` in scope
[INFO] [stderr] 
[INFO] [stderr] warning: unresolved link to `Error::NoTupleTable`
[INFO] [stderr]    --> src/spi/tuple.rs:258:47
[INFO] [stderr]     |
[INFO] [stderr] 258 |     /// If we have no backing tuple table a [`Error::NoTupleTable`] is returned
[INFO] [stderr]     |                                               ^^^^^^^^^^^^^^^^^^^ no item named `Error` in scope
[INFO] [stderr] 
[INFO] [stderr] warning: unresolved link to `Error::DatumError`
[INFO] [stderr]    --> src/spi/tuple.rs:354:21
[INFO] [stderr]     |
[INFO] [stderr] 354 |     /// Returns a [`Error::DatumError`] if the desired Rust type is incompatible
[INFO] [stderr]     |                     ^^^^^^^^^^^^^^^^^ no item named `Error` in scope
[INFO] [stderr] 
[INFO] [stderr] warning: unresolved link to `Error::DatumError`
[INFO] [stderr]    --> src/spi/tuple.rs:364:21
[INFO] [stderr]     |
[INFO] [stderr] 364 |     /// Returns a [`Error::DatumError`] if the desired Rust type is incompatible
[INFO] [stderr]     |                     ^^^^^^^^^^^^^^^^^ no item named `Error` in scope
[INFO] [stderr] 
[INFO] [stderr] warning: unresolved link to `UTF8Error`
[INFO] [stderr]    --> src/stringinfo.rs:191:54
[INFO] [stderr]     |
[INFO] [stderr] 191 |     /// If the contained bytes aren't valid UTF8, a [UTF8Error] is returned.  Postgres StringInfo
[INFO] [stderr]     |                                                      ^^^^^^^^^ no item named `UTF8Error` in scope
[INFO] [stderr]     |
[INFO] [stderr]     = help: to escape `[` and `]` characters, add '\' before them like `\[` or `\]`
[INFO] [stderr] 
[INFO] [stderr] warning: unresolved link to `crate::PgHeapTuple`
[INFO] [stderr]   --> src/trigger_support/mod.rs:12:57
[INFO] [stderr]    |
[INFO] [stderr] 12 | A "no-op" trigger that gets the current [`PgHeapTuple`][crate::PgHeapTuple],
[INFO] [stderr]    |                                                         ^^^^^^^^^^^^^^^^^^ no item named `PgHeapTuple` in module `pgrx`
[INFO] [stderr] 
[INFO] [stderr] warning: unresolved link to `crate::PgHeapTuple`
[INFO] [stderr]   --> src/trigger_support/mod.rs:28:26
[INFO] [stderr]    |
[INFO] [stderr] 28 | either a [`PgHeapTuple`][crate::PgHeapTuple] or any error that implements [`impl std::error::Error`][std::error::Error].
[INFO] [stderr]    |                          ^^^^^^^^^^^^^^^^^^ no item named `PgHeapTuple` in module `pgrx`
[INFO] [stderr] 
[INFO] [stderr] warning: unresolved link to `crate::PgHeapTuple`
[INFO] [stderr]   --> src/trigger_support/mod.rs:94:46
[INFO] [stderr]    |
[INFO] [stderr] 94 | Trigger functions can return [`PgHeapTuple`][crate::PgHeapTuple]s which are [`AllocatedByRust`][crate::AllocatedByRust]
[INFO] [stderr]    |                                              ^^^^^^^^^^^^^^^^^^ no item named `PgHeapTuple` in module `pgrx`
[INFO] [stderr] 
[INFO] [stderr] warning: unresolved link to `crate::PgHeapTuple`
[INFO] [stderr]   --> src/trigger_support/trigger_tuple.rs:10:54
[INFO] [stderr]    |
[INFO] [stderr] 10 | /// Indicates which trigger tuple to convert into a [crate::PgHeapTuple].
[INFO] [stderr]    |                                                      ^^^^^^^^^^^^^^^^^^ no item named `PgHeapTuple` in module `pgrx`
[INFO] [stderr] 
[INFO] [stderr] warning: unresolved link to `register_pg_guard_panic_hook`
[INFO] [stderr]    --> src/lib.rs:344:35
[INFO] [stderr]     |
[INFO] [stderr] 344 | /// Sets up panic handling with [`register_pg_guard_panic_hook()`] to ensure that a crash within
[INFO] [stderr]     |                                   ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ no item named `register_pg_guard_panic_hook` in scope
[INFO] [stderr]     |
[INFO] [stderr]     = help: to escape `[` and `]` characters, add '\' before them like `\[` or `\]`
[INFO] [stderr] 
[INFO] [stderr] warning: unresolved link to `RangeBound::infinite`
[INFO] [stderr]    --> src/datum/range.rs:125:11
[INFO] [stderr]     |
[INFO] [stderr] 125 |     /// [`RangeBound::infinite`] value.
[INFO] [stderr]     |           ^^^^^^^^^^^^^^^^^^^^ the enum `RangeBound` has no variant or associated item named `infinite`
[INFO] [stderr] 
[INFO] [stderr] warning: unresolved link to `core::ffi::CString`
[INFO] [stderr]    --> src/datum/into.rs:362:15
[INFO] [stderr]     |
[INFO] [stderr] 362 |     /// The [`core::ffi::CString`] is copied to `palloc`'d memory.  That memory will either be freed by
[INFO] [stderr]     |               ^^^^^^^^^^^^^^^^^^ no item named `CString` in module `ffi`
[INFO] [stderr] 
[INFO] [stderr] warning: unresolved link to `PgSqlErrorCode::ERRCODE_DATA_EXCEPTION`
[INFO] [stderr]    --> src/datum/into.rs:104:15
[INFO] [stderr]     |
[INFO] [stderr] 104 |     /// the [`PgSqlErrorCode::ERRCODE_DATA_EXCEPTION`] error code.
[INFO] [stderr]     |               ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ no item named `PgSqlErrorCode` in scope
[INFO] [stderr] 
[INFO] [stderr] warning: unresolved link to `DateTimePart`
[INFO] [stderr]    --> src/datum/datetime_support/mod.rs:132:59
[INFO] [stderr]     |
[INFO] [stderr] 132 |     /// Convert to Postgres' string representation of a [`DateTimePart`]
[INFO] [stderr]     |                                                           ^^^^^^^^^^^^ no item named `DateTimePart` in scope
[INFO] [stderr]     |
[INFO] [stderr]     = help: to escape `[` and `]` characters, add '\' before them like `\[` or `\]`
[INFO] [stderr] 
[INFO] [stderr] warning: redundant explicit link target
[INFO] [stderr]   --> src/aggregate.rs:83:21
[INFO] [stderr]    |
[INFO] [stderr] 83 | [`Aggregate::Args`](Aggregate::Args) associated type can be a tuple:
[INFO] [stderr]    |  -----------------  ^^^^^^^^^^^^^^^ explicit target is redundant
[INFO] [stderr]    |  |
[INFO] [stderr]    |  because label contains path that resolves to same destination
[INFO] [stderr]    |
[INFO] [stderr]    = note: when a link's destination is not specified,
[INFO] [stderr]            the label is used to resolve intra-doc links
[INFO] [stderr]    = note: `#[warn(rustdoc::redundant_explicit_links)]` on by default
[INFO] [stderr] help: remove explicit link target
[INFO] [stderr]    |
[INFO] [stderr] 83 | [`Aggregate::Args`] associated type can be a tuple:
[INFO] [stderr]    | ~~~~~~~~~~~~~~~~~~~
[INFO] [stderr] 
[INFO] [stderr] warning: unclosed HTML tag `T`
[INFO] [stderr]    --> src/datum/array.rs:517:37
[INFO] [stderr]     |
[INFO] [stderr] 517 |     /// Return an Iterator of Option<T> over the contained Datums.
[INFO] [stderr]     |                                     ^^^
[INFO] [stderr]     |
[INFO] [stderr]     = note: `#[warn(rustdoc::invalid_html_tags)]` on by default
[INFO] [stderr] help: try marking as source code
[INFO] [stderr]     |
[INFO] [stderr] 517 |     /// Return an Iterator of `Option<T>` over the contained Datums.
[INFO] [stderr]     |                               +         +
[INFO] [stderr] 
[INFO] [stderr] warning: this URL is not a hyperlink
[INFO] [stderr]   --> src/datum/interval.rs:19:23
[INFO] [stderr]    |
[INFO] [stderr] 19 | /// From the PG docs  https://www.postgresql.org/docs/current/datatype-datetime.html#DATATYPE-INTERVAL-INPUT
[INFO] [stderr]    |                       ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ help: use an automatic link instead: `<https://www.postgresql.org/docs/current/datatype-datetime.html#DATATYPE-INTERVAL-INPUT>`
[INFO] [stderr]    |
[INFO] [stderr]    = note: bare URLs are not automatically turned into clickable links
[INFO] [stderr]    = note: `#[warn(rustdoc::bare_urls)]` on by default
[INFO] [stderr] 
[INFO] [stderr] warning: redundant explicit link target
[INFO] [stderr]   --> src/htup.rs:10:62
[INFO] [stderr]    |
[INFO] [stderr] 10 | //! Utility functions for working with [`pg_sys::HeapTuple`][crate::pg_sys::HeapTuple] and [`pg_sys::HeapTupleHeader`][crate::pg_sys::Hea...
[INFO] [stderr]    |                                         -------------------  ^^^^^^^^^^^^^^^^^^^^^^^^ explicit target is redundant
[INFO] [stderr]    |                                         |
[INFO] [stderr]    |                                         because label contains path that resolves to same destination
[INFO] [stderr]    |
[INFO] [stderr]    = note: when a link's destination is not specified,
[INFO] [stderr]            the label is used to resolve intra-doc links
[INFO] [stderr] help: remove explicit link target
[INFO] [stderr]    |
[INFO] [stderr] 10 | //! Utility functions for working with [`pg_sys::HeapTuple`] and [`pg_sys::HeapTupleHeader`][crate::pg_sys::HeapTupleHeader] structs
[INFO] [stderr]    |                                        ~~~~~~~~~~~~~~~~~~~~~
[INFO] [stderr] 
[INFO] [stderr] warning: redundant explicit link target
[INFO] [stderr]   --> src/htup.rs:10:120
[INFO] [stderr]    |
[INFO] [stderr] 10 | ...g_sys::HeapTuple] and [`pg_sys::HeapTupleHeader`][crate::pg_sys::HeapTupleHeader] structs
[INFO] [stderr]    |                           -------------------------  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ explicit target is redundant
[INFO] [stderr]    |                           |
[INFO] [stderr]    |                           because label contains path that resolves to same destination
[INFO] [stderr]    |
[INFO] [stderr]    = note: when a link's destination is not specified,
[INFO] [stderr]            the label is used to resolve intra-doc links
[INFO] [stderr] help: remove explicit link target
[INFO] [stderr]    |
[INFO] [stderr] 10 | //! Utility functions for working with [`pg_sys::HeapTuple`][crate::pg_sys::HeapTuple] and [`pg_sys::HeapTupleHeader`] structs
[INFO] [stderr]    |                                                                                            ~~~~~~~~~~~~~~~~~~~~~~~~~~~
[INFO] [stderr] 
[INFO] [stderr] warning: redundant explicit link target
[INFO] [stderr]   --> src/list.rs:12:46
[INFO] [stderr]    |
[INFO] [stderr] 12 | //! It functions similarly to a Rust [`Vec`][std::vec::Vec], including iterator support, but provides separate
[INFO] [stderr]    |                                       -----  ^^^^^^^^^^^^^ explicit target is redundant
[INFO] [stderr]    |                                       |
[INFO] [stderr]    |                                       because label contains path that resolves to same destination
[INFO] [stderr]    |
[INFO] [stderr]    = note: when a link's destination is not specified,
[INFO] [stderr]            the label is used to resolve intra-doc links
[INFO] [stderr] help: remove explicit link target
[INFO] [stderr]    |
[INFO] [stderr] 12 | //! It functions similarly to a Rust [`Vec`], including iterator support, but provides separate
[INFO] [stderr]    |                                      ~~~~~~~
[INFO] [stderr] 
[INFO] [stderr] warning: Rust code block is empty
[INFO] [stderr]    --> src/trigger_support/mod.rs:179:1
[INFO] [stderr]     |
[INFO] [stderr] 179 | / ```
[INFO] [stderr] 180 | |
[INFO] [stderr] 181 | |  */
[INFO] [stderr]     | |_^
[INFO] [stderr]     |
[INFO] [stderr]     = note: `#[warn(rustdoc::invalid_rust_codeblocks)]` on by default
[INFO] [stderr] help: mark blocks that do not contain Rust code as text
[INFO] [stderr]     |
[INFO] [stderr] 179 | ```text
[INFO] [stderr]     |    ++++
[INFO] [stderr] 
[INFO] [stderr] warning: redundant explicit link target
[INFO] [stderr]   --> src/trigger_support/mod.rs:27:91
[INFO] [stderr]    |
[INFO] [stderr] 27 | Trigger functions only accept one argument, a [`PgTrigger`], and they return a [`Result`][std::result::Result] containing
[INFO] [stderr]    |                                                                                 --------  ^^^^^^^^^^^^^^^^^^^ explicit target is redundant
[INFO] [stderr]    |                                                                                 |
[INFO] [stderr]    |                                                                                 because label contains path that resolves to same destination
[INFO] [stderr]    |
[INFO] [stderr]    = note: when a link's destination is not specified,
[INFO] [stderr]            the label is used to resolve intra-doc links
[INFO] [stderr] help: remove explicit link target
[INFO] [stderr]    |
[INFO] [stderr] 27 | Trigger functions only accept one argument, a [`PgTrigger`], and they return a [`Result`] containing
[INFO] [stderr]    |                                                                                ~~~~~~~~~~
[INFO] [stderr] 
[INFO] [stderr] warning: unclosed HTML tag `T`
[INFO] [stderr]   --> src/datum/into.rs:77:55
[INFO] [stderr]    |
[INFO] [stderr] 77 | /// for supporting NULL as the None value of an Option<T>
[INFO] [stderr]    |                                                       ^^^
[INFO] [stderr]    |
[INFO] [stderr] help: try marking as source code
[INFO] [stderr]    |
[INFO] [stderr] 77 | /// for supporting NULL as the None value of an `Option<T>`
[INFO] [stderr]    |                                                 +         +
[INFO] [stderr] 
[INFO] [stderr] warning: `pgrx` (lib doc) generated 32 warnings (run `cargo fix --lib -p pgrx` to apply 2 suggestions)
[INFO] [stderr]     Finished `dev` profile [unoptimized + debuginfo] target(s) in 5.56s
[INFO] [stderr]    Generated /opt/rustwide/target/x86_64-unknown-linux-gnu/doc/pgrx/index.html
[INFO] running `Command { std: "docker" "inspect" "87f7c8cf80ad1109793bce692d97ccd38e5212b6ec1bd62f64bdb097d8b04a98", kill_on_drop: false }`
[INFO] running `Command { std: "docker" "rm" "-f" "87f7c8cf80ad1109793bce692d97ccd38e5212b6ec1bd62f64bdb097d8b04a98", kill_on_drop: false }`
[INFO] [stdout] 87f7c8cf80ad1109793bce692d97ccd38e5212b6ec1bd62f64bdb097d8b04a98