Skip to content

Commit

Permalink
add more docs
Browse files Browse the repository at this point in the history
Signed-off-by: Bugen Zhao <[email protected]>
  • Loading branch information
BugenZhao committed Aug 6, 2024
1 parent e6411a3 commit 0d8e2e3
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions src/common/src/system_param/reader.rs
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,15 @@ use super::{default, ParamValue};
use crate::for_all_params;

/// Information about a system parameter.
///
/// Used to display to users through `pg_settings` system table and `SHOW PARAMETERS` command.
pub struct ParameterInfo {
pub name: &'static str,
pub mutable: bool,
/// The [`ToString`] representation of the parameter value.
///
/// Certain parameters, such as `license_key`, may be sensitive, and redaction is applied to them in their newtypes.
/// As a result, we get the redacted value here for display.
pub value: String,
pub description: &'static str,
}
Expand Down

0 comments on commit 0d8e2e3

Please sign in to comment.