Struct Clients 

pub struct Clients<M = Unselected> { /* private fields */ }

p4 [g-opts] clients [-t] [-u user [--user-case-insensitive] | --me] [[-e|-E] filter] [-m max] [-S stream] [-a | -s serverID]

p4 [g-opts] clients -U

List all client workspaces currently known to the system.

The command p4 workspaces is an alias for p4 clients.

The M type parameter tracks the command form at compile time, starting as Unselected from Clients::new, which spawns the bare p4 clients report. Set any regular option or filter (for example Self::display_time, Self::filter, or Self::user) to enter RegularMode, or call Self::unloaded (-U) to enter UnloadedMode.

Implementations

impl Clients<Unselected>

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

Creates a new p4 clients command with no option selected.

bin is the path to the Perforce command-line executable. The command spawns the bare p4 clients report as is; set any regular option or filter to enter RegularMode, or call Self::unloaded to enter UnloadedMode.

pub fn unloaded(self) -> Clients<UnloadedMode>

Description

-U

List only client workspaces unloaded with p4 unload.

This is a standalone syntax form (p4 clients -U) that accepts no other options.

Transitions this command to the UnloadedMode state.

pub fn display_time(self, v: bool) -> Clients<RegularMode>

Description

-t

Display the time as well as the date of the last update to the workspace.

Transitions this command to the RegularMode state.

pub fn limit(self, v: u64) -> Clients<RegularMode>

Description

-m max

List only the first max client workspaces.

Transitions this command to the RegularMode state.

pub fn stream(self, v: impl Into<String>) -> Clients<RegularMode>

Description

-S stream

List client workspaces associated with the specified stream.

Transitions this command to the RegularMode state.

pub fn filter( self, v: impl Into<String>, case_insensitive: bool, ) -> Clients<RegularMode<Filter, Unselected, Unselected>>

Description

-e filter / -E filter

v is the client workspace name filter pattern; lists only client workspaces whose name matches it.

When case_insensitive is false (-e), the pattern is matched using the server’s normal case-sensitivity rules. When case_insensitive is true (-E), the pattern is matched case-insensitively, even on a case-sensitive server.

--client-case-insensitive is equivalent to -E.

Transitions this command to the Filter state.

pub fn user( self, v: impl Into<String>, ) -> Clients<RegularMode<Unselected, User, Unselected>>

Description

-u user [–user-case-insensitive]

List client workspaces that are owned by v. This can include * wildcards to form a search pattern. If wildcards are used, enclose the search pattern in double quotes (").

For example:

p4 clients -u "O*hara"

Call Clients::case_insensitive on the entered state to add the --user-case-insensitive suboption.

Transitions this command to the User state.

pub fn filter_me(self) -> Clients<RegularMode<Unselected, Me, Unselected>>

Description

–me

Equivalent to -u $P4USER.

Transitions this command to the Me state.

pub fn all(self) -> Clients<RegularMode<Unselected, Unselected, ListAll>>

Description

-a

List all client workspaces, not just workspaces bound to this server.

Transitions this command to the ListAll state.

pub fn server_id( self, v: impl Into<String>, ) -> Clients<RegularMode<Unselected, Unselected, ListSpecified>>

Description

-s serverID

List only client workspaces bound to the specified serverID. On an edge server, the -s option defaults to the edge server’s serverID.

Transitions this command to the ListSpecified state.

impl<M> Clients<M>

pub fn get_bin(&self) -> &Path

Get the Perforce command path.

pub fn set_bin(&mut self, bin: impl Into<PathBuf>) -> &mut Self

Set the Perforce command path.

pub fn bin(self, bin: impl Into<PathBuf>) -> Self

Set the Perforce command path.

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.

impl<F, U, C> Clients<RegularMode<F, U, C>>

pub fn get_limit(&self) -> Option<u64>

Description

-m max

List only the first max client workspaces.

pub fn set_limit(&mut self, v: u64) -> &mut Self

Description

-m max

List only the first max client workspaces.

pub fn limit(self, v: u64) -> Self

Description

-m max

List only the first max client workspaces.

pub fn get_display_time(&self) -> bool

Description

-t

Display the time as well as the date of the last update to the workspace.

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

Description

-t

Display the time as well as the date of the last update to the workspace.

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

Description

-t

Display the time as well as the date of the last update to the workspace.

pub fn get_stream(&self) -> Option<&String>

Description

-S stream

List client workspaces associated with the specified stream.

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

Description

-S stream

List client workspaces associated with the specified stream.

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

Description

-S stream

List client workspaces associated with the specified stream.

impl<U, C> Clients<RegularMode<Unselected, U, C>>

pub fn filter( self, v: impl Into<String>, case_insensitive: bool, ) -> Clients<RegularMode<Filter, U, C>>

Description

-e filter / -E filter

v is the client workspace name filter pattern; lists only client workspaces whose name matches it.

When case_insensitive is false (-e), the pattern is matched using the server’s normal case-sensitivity rules. When case_insensitive is true (-E), the pattern is matched case-insensitively, even on a case-sensitive server.

--client-case-insensitive is equivalent to -E.

Transitions this command to the Filter state.

impl<F, C> Clients<RegularMode<F, Unselected, C>>

pub fn user(self, v: impl Into<String>) -> Clients<RegularMode<F, User, C>>

Description

-u user [–user-case-insensitive]

List client workspaces that are owned by v. This can include * wildcards to form a search pattern. If wildcards are used, enclose the search pattern in double quotes (").

For example:

p4 clients -u "O*hara"

Call Clients::case_insensitive on the entered state to add the --user-case-insensitive suboption.

Transitions this command to the User state.

pub fn filter_me(self) -> Clients<RegularMode<F, Me, C>>

Description

–me

Equivalent to -u $P4USER.

Transitions this command to the Me state.

impl<F, C> Clients<RegularMode<F, User, C>>

pub fn case_insensitive(self) -> Clients<RegularMode<F, User, C>>

Description

–user-case-insensitive

Indicates that the -u user value is a case-insensitive search pattern, even on a case-sensitive server.

For example:

p4 clients -u "O*hara" --user-case-insensitive

impl<F, U> Clients<RegularMode<F, U, Unselected>>

pub fn all(self) -> Clients<RegularMode<F, U, ListAll>>

Description

-a

List all client workspaces, not just workspaces bound to this server.

Transitions this command to the ListAll state.

pub fn server_id( self, v: impl Into<String>, ) -> Clients<RegularMode<F, U, ListSpecified>>

Description

-s serverID

List only client workspaces bound to the specified serverID. On an edge server, the -s option defaults to the edge server’s serverID.

Transitions this command to the ListSpecified state.

Trait Implementations

impl<M: Clone> Clone for Clients<M>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<M: Debug> Debug for Clients<M>

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

Formats the value using the given formatter.

impl<M: Default> Default for Clients<M>

fn default() -> Self

Returns the “default value” for a type.

impl ParameterizedSpawn<()> for Clients<Unselected>

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

Spawns p4 clients 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 Output = Child

type Error = Error

impl<F: ExclusiveOption, U: ExclusiveOption, C: ExclusiveOption> ParameterizedSpawn<()> for Clients<RegularMode<F, U, C>>

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

Spawns p4 clients 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 Output = Child

type Error = Error

impl ParameterizedSpawn<()> for Clients<UnloadedMode>

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

Spawns p4 clients -U 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 Output = Child

type Error = Error

impl SubCommand for Clients<Unselected>

fn name(&self) -> &str

fn inject_local_args(&self, _: &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

impl<F: ExclusiveOption, U: ExclusiveOption, C: ExclusiveOption> SubCommand for Clients<RegularMode<F, U, C>>

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

impl SubCommand for Clients<UnloadedMode>

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