Struct ControlFile

pub struct ControlFile {
    pub comment: String,
    pub default_version: String,
    pub module_pathname: Option<String>,
    pub relocatable: bool,
    pub superuser: bool,
    pub schema: Option<String>,
    pub trusted: bool,
}

The parsed contents of a .control file.

use pgrx_sql_entity_graph::ControlFile;
use std::convert::TryFrom;
let context = include_str!("../../pgrx-examples/arrays/arrays.control");
let _control_file = ControlFile::try_from(context)?;

Fields

comment: String

default_version: String

module_pathname: Option<String>

relocatable: bool

superuser: bool

schema: Option<String>

trusted: bool

Implementations

impl ControlFile

pub fn from_str(input: &str) -> Result<Self, ControlFileError>

Parse a .control file, performing all known pgrx dynamic variable substitutions.

Supported Dynamic Variable Substitutions

@CARGO_VERSION@: Replaced with the value of the environment variable CARGO_PKG_VERSION, which is set by cargo, or failing that, cargo-pgrx using the package version from the extension’s Cargo.toml file

Errors

Returns a ControlFileError if any of the required fields are missing from the input string or if any required environment variables (for dynamic variable substitution) are missing

use pgrx_sql_entity_graph::ControlFile;
let context = include_str!("../../pgrx-examples/arrays/arrays.control");
let _control_file = ControlFile::from_str(context)?;

Trait Implementations

impl Clone for ControlFile

fn clone(&self) -> ControlFile

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ControlFile

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<ControlFile> for SqlGraphEntity

fn from(val: ControlFile) -> Self

Converts to this type from the input type.

impl Hash for ControlFile

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for ControlFile

fn cmp(&self, other: &ControlFile) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for ControlFile

fn eq(&self, other: &ControlFile) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for ControlFile

fn partial_cmp(&self, other: &ControlFile) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl SqlGraphIdentifier for ControlFile

fn dot_identifier(&self) -> String

A dot style identifier for the entity.

fn rust_identifier(&self) -> String

A Rust identifier for the entity.

fn file(&self) -> Option<&'static str>

fn line(&self) -> Option<u32>

impl ToSql for ControlFile

fn to_sql(&self, _context: &PgrxSql) -> Result<String>

Attempt to transform this type into SQL.

impl TryFrom<&str> for ControlFile

type Error = ControlFileError

The type returned in the event of a conversion error.

fn try_from(input: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<PathBuf> for ControlFile

type Error = ControlFileError

The type returned in the event of a conversion error.

fn try_from(value: PathBuf) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for ControlFile

impl StructuralPartialEq for ControlFile