pub struct FunctionLikeParameter<'arena> {
pub attribute_lists: Sequence<'arena, AttributeList<'arena>>,
pub modifiers: Sequence<'arena, Modifier<'arena>>,
pub hint: Option<Hint<'arena>>,
pub ampersand: Option<Span>,
pub ellipsis: Option<Span>,
pub variable: DirectVariable<'arena>,
pub default_value: Option<FunctionLikeParameterDefaultValue<'arena>>,
pub hooks: Option<PropertyHookList<'arena>>,
}Expand description
Represents a function-like parameter in PHP.
Example: int $foo, string &$bar, bool ...$baz, mixed $qux = null
Fields§
§attribute_lists: Sequence<'arena, AttributeList<'arena>>§modifiers: Sequence<'arena, Modifier<'arena>>§hint: Option<Hint<'arena>>§ampersand: Option<Span>§ellipsis: Option<Span>§variable: DirectVariable<'arena>§default_value: Option<FunctionLikeParameterDefaultValue<'arena>>§hooks: Option<PropertyHookList<'arena>>Implementations§
Source§impl FunctionLikeParameter<'_>
impl FunctionLikeParameter<'_>
Sourcepub fn is_promoted_property(&self) -> bool
pub fn is_promoted_property(&self) -> bool
Returns whether the parameter is a promoted property.
A promoted property is a property that is declared in a constructor parameter list.
A parameter is considered a promoted property if it has at least one modifier or a hook.
pub const fn is_variadic(&self) -> bool
pub const fn is_reference(&self) -> bool
Trait Implementations§
Source§impl<'arena> Clone for FunctionLikeParameter<'arena>
impl<'arena> Clone for FunctionLikeParameter<'arena>
Source§fn clone(&self) -> FunctionLikeParameter<'arena>
fn clone(&self) -> FunctionLikeParameter<'arena>
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl<'arena> Debug for FunctionLikeParameter<'arena>
impl<'arena> Debug for FunctionLikeParameter<'arena>
Source§impl HasSpan for FunctionLikeParameter<'_>
impl HasSpan for FunctionLikeParameter<'_>
Source§fn start_position(&self) -> Position
fn start_position(&self) -> Position
Source§fn start_offset(&self) -> u32
fn start_offset(&self) -> u32
Source§fn end_position(&self) -> Position
fn end_position(&self) -> Position
Source§fn end_offset(&self) -> u32
fn end_offset(&self) -> u32
Source§impl<'arena> Hash for FunctionLikeParameter<'arena>
impl<'arena> Hash for FunctionLikeParameter<'arena>
Source§impl<'arena> Ord for FunctionLikeParameter<'arena>
impl<'arena> Ord for FunctionLikeParameter<'arena>
Source§fn cmp(&self, other: &FunctionLikeParameter<'arena>) -> Ordering
fn cmp(&self, other: &FunctionLikeParameter<'arena>) -> Ordering
1.21.0 · Source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere
Self: Sized,
Source§impl<'arena> PartialEq for FunctionLikeParameter<'arena>
impl<'arena> PartialEq for FunctionLikeParameter<'arena>
Source§fn eq(&self, other: &FunctionLikeParameter<'arena>) -> bool
fn eq(&self, other: &FunctionLikeParameter<'arena>) -> bool
self and other values to be equal, and is used by ==.Source§impl<'arena> PartialOrd for FunctionLikeParameter<'arena>
impl<'arena> PartialOrd for FunctionLikeParameter<'arena>
Source§impl<'arena> Serialize for FunctionLikeParameter<'arena>
impl<'arena> Serialize for FunctionLikeParameter<'arena>
impl<'arena> Eq for FunctionLikeParameter<'arena>
impl<'arena> StructuralPartialEq for FunctionLikeParameter<'arena>
Auto Trait Implementations§
impl<'arena> Freeze for FunctionLikeParameter<'arena>
impl<'arena> !RefUnwindSafe for FunctionLikeParameter<'arena>
impl<'arena> !Send for FunctionLikeParameter<'arena>
impl<'arena> !Sync for FunctionLikeParameter<'arena>
impl<'arena> Unpin for FunctionLikeParameter<'arena>
impl<'arena> !UnwindSafe for FunctionLikeParameter<'arena>
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<Q, K> Comparable<K> for Q
impl<Q, K> Comparable<K> for Q
Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key and return true if they are equal.Source§impl<T> HasPosition for Twhere
T: HasSpan,
impl<T> HasPosition for Twhere
T: HasSpan,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);