Struct Attribute 

pub struct Attribute<S = Standard, T = Unselected> { /* private fields */ }

p4 [g-opts] attribute [-e -f -p] -n name [-v value [-T0 | -T1]] files ...: set per-revision attributes on revisions.

p4 [g-opts] attribute [-e -f -p [-T0 | -T1]] -i -n name file

p4 attribute [-f -p [-T0 | -T1]] -I filename -n name file

The S type parameter tracks the value source: Standard for the default -n/-v set-or-clear form, FromStdin for the -i form, FromFile for the -I filename form, and and the T type parameter tracks the -T0/-T1 trait storage location.

Implementations

impl Attribute<Standard, Unselected>

pub fn new(bin: impl Into<PathBuf>, global_opts: GlobalOpts) -> Self

Creates a new p4 attribute command.

bin is the path to the Perforce command-line executable.

impl<T: ExclusiveOption> Attribute<Standard, T>

pub fn set( &mut self, name: impl Into<String>, value: impl Into<String>, ) -> &mut Self

Description

-n name -v value

Sets the attribute name to value on the given files. The supplied value must be text.

pub fn clear(&mut self, name: impl Into<String>) -> &mut Self

Description

-n name

Clears the attribute name on the given files by omitting the -v option.

pub fn get_hex(&self) -> bool

Description

-e

Indicates that the value is specified in hex.

pub fn set_hex(&mut self, v: bool) -> &mut Self

Description

-e

Indicates that the value is specified in hex.

pub fn hex(self, v: bool) -> Self

Description

-e

Indicates that the value is specified in hex.

pub fn read_from_stdin(self, name: String) -> Attribute<FromStdin, T>

Description

-i

Read an attribute value from the standard input. Only one file argument is allowed when using this option. This option supports both textual and binary content.

Transitions this command to the FromStdin state; any -n/-v pairs set with Self::set or Self::clear are discarded, while -e is preserved.

pub fn read_from_file( self, name: String, file: PathBuf, ) -> Attribute<FromFile, T>

Description

-I filename

Read the attribute value from a file. The file can have textual or binary content. Use this when the attribute data exceeds 250 megabytes, which might cause the command to fail with the Rpc buffer too big error. The following are not allowed with this option:

• Using the -e option to specify the value as hex.
• More than one file argument.
• Setting more than one trait value.

To display attributes set with this option, use the p4 print -T command instead of the p4 fstat -Oa command because p4 print -T can handle larger non-encoded binary data.

Transitions this command to the FromFile state; any -n/-v pairs set with Self::set or Self::clear, as well as -e, are discarded.

impl<T: ExclusiveOption> Attribute<FromStdin, T>

pub fn get_hex(&self) -> bool

Description

-e

Indicates that the value is specified in hex.

pub fn set_hex(&mut self, v: bool) -> &mut Self

Description

-e

Indicates that the value is specified in hex.

pub fn hex(self, v: bool) -> Self

Description

-e

Indicates that the value is specified in hex.

pub fn get_name(&self) -> &str

Description

-n name

The name of the attribute read from standard input.

pub fn set_name(&mut self, v: impl Into<String>) -> &mut Self

Description

-n name

The name of the attribute read from standard input.

pub fn name(self, v: impl Into<String>) -> Self

Description

-n name

The name of the attribute read from standard input.

pub fn output<S, V>(&self, file: S, value: V) -> Result<Output, Error>

where S: AsRef<OsStr>, V: AsRef<[u8]>,

Runs p4 attribute -i for a single file, writing value to the child’s standard input, and captures the command’s output.

Unlike ParameterizedSpawn::spawn_with, this method handles writing the attribute value to the child’s standard input itself, so it is the most convenient way to submit values through standard input.

Only one file argument is allowed in the FromStdin state.

impl<T: ExclusiveOption> Attribute<FromFile, T>

pub fn get_name(&self) -> &str

Description

-n name

The name of the attribute read from the file.

pub fn set_name(&mut self, v: impl Into<String>) -> &mut Self

Description

-n name

The name of the attribute read from the file.

pub fn name(self, v: impl Into<String>) -> Self

Description

-n name

The name of the attribute read from the file.

pub fn get_file(&self) -> &Path

Description

-I filename

The file the attribute value is read from.

impl<S: ExclusiveOption, T: ExclusiveOption> Attribute<S, T>

pub fn get_global_opts(&self) -> &GlobalOpts

Description

g-opts

See Global options.

pub fn set_global_opts(&mut self, v: GlobalOpts) -> &mut Self

Description

g-opts

See Global options.

pub fn global_opts(self, v: GlobalOpts) -> Self

Description

g-opts

See Global options.

pub fn get_on_submitted_files(&self) -> bool

Description

-f

Set the attribute on submitted files. If a propagating trait is set on a submitted file, a revision specifier cannot be used, and the file must not be currently open in any workspace.

pub fn set_on_submitted_files(&mut self, v: bool) -> &mut Self

Description

-f

Set the attribute on submitted files. If a propagating trait is set on a submitted file, a revision specifier cannot be used, and the file must not be currently open in any workspace.

pub fn on_submitted_files(self, v: bool) -> Self

Description

-f

Set the attribute on submitted files. If a propagating trait is set on a submitted file, a revision specifier cannot be used, and the file must not be currently open in any workspace.

pub fn get_propagating(&self) -> bool

Description

-p

Create a propagating attribute: an attribute whose value is propagated to subsequent revisions whenever the file is opened. Relevant commands include p4 copy, p4 delete, p4 edit, p4 integrate, p4 reconcile, p4 resolve, p4 shelve, p4 submit, and p4 unshelve.

pub fn set_propagating(&mut self, v: bool) -> &mut Self

Description

-p

Create a propagating attribute: an attribute whose value is propagated to subsequent revisions whenever the file is opened. Relevant commands include p4 copy, p4 delete, p4 edit, p4 integrate, p4 reconcile, p4 resolve, p4 shelve, p4 submit, and p4 unshelve.

pub fn propagating(self, v: bool) -> Self

Description

-p

Create a propagating attribute: an attribute whose value is propagated to subsequent revisions whenever the file is opened. Relevant commands include p4 copy, p4 delete, p4 edit, p4 integrate, p4 reconcile, p4 resolve, p4 shelve, p4 submit, and p4 unshelve.

impl<S: ExclusiveOption, T: ExclusiveOption> Attribute<S, T>

pub fn store_in_database_traits(self) -> Attribute<S, DatabaseTraits>

Description

-T0

Causes the value to be stored in the db.traits table, which is the implicit default.

pub fn store_in_trait_depot(self) -> Attribute<S, TraitDepot>

Description

-T1

Causes the value to be stored in the trait depot instead of the db.traits table, even if the size of the attribute value is less than the size specified by the trait.storagedepot.min configurable. However, if trait.storagedepot.min is unset or set to 0, the attribute value is stored in the db.traits table.

Trait Implementations

impl<S: Clone, T: Clone> Clone for Attribute<S, T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S: Debug, T: Debug> Debug for Attribute<S, T>

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

Formats the value using the given formatter.

impl<S: Default, T: Default> Default for Attribute<S, T>

fn default() -> Self

Returns the “default value” for a type.

impl<T: ExclusiveOption> ParameterizedSpawn for Attribute<Standard, T>

fn spawn_with<'a>( &mut self, files: Self::Input<'a>, ) -> Result<Self::Output<'a>, Self::Error>

Spawns p4 attribute for the given files as a child process with piped standard output and error streams; use the returned Child handle to wait for it or interact with it.

type Input<'a> = &'a [&'a OsStr]

type Output<'a> = Child

type Error = Error

impl<T: ExclusiveOption> ParameterizedSpawn for Attribute<FromStdin, T>

fn spawn_with<'a>( &mut self, input: Self::Input<'a>, ) -> Result<Self::Output<'a>, Self::Error>

Spawns p4 attribute -i for a single file as a child process with the given standard input configuration and piped standard output and error streams; use the returned Child handle to wait for it or interact with it.

Pass Stdio::piped() to obtain a writable child.stdin handle and write the attribute value yourself, then drop it before waiting on the child. Only one file argument is allowed in the FromStdin state.

type Input<'a> = (&'a OsStr, Stdio)

type Output<'a> = Child

type Error = Error

impl<T: ExclusiveOption> ParameterizedSpawn for Attribute<FromFile, T>

Available on non-crate feature lt2024_2 only.

fn spawn_with<'a>( &mut self, file: Self::Input<'a>, ) -> Result<Self::Output<'a>, Self::Error>

Spawns p4 attribute -I for a single file as a child process with piped standard output and error streams; use the returned Child handle to wait for it or interact with it.

Only one file argument is allowed in the FromFile state.

type Input<'a> = &'a OsStr

type Output<'a> = Child

type Error = Error

impl<S: ExclusiveOption, T: ExclusiveOption> SubCommand for Attribute<S, T>

fn name(&self) -> &str

fn inject_local_args(&self, command: &mut Command)

fn global_opts(&self) -> Option<&GlobalOpts>

fn inject_args(&self, command: &mut Command)

fn setup_command<S: AsRef<OsStr>>(&self, bin: S) -> Command