Struct SyminfoFields 

pub struct SyminfoFields(/* private fields */);

Bitset of syminfo property fields requested by a compiled script.

Each bit corresponds to the index passed to @native.syminfo(N) in crates/builtins/stdlib/syminfo.1.pine. The set is computed statically during the visitor pass and stored on the compiled Program so that [DataProvider::symbol_info] can fetch only the fields that are actually used.

Implementations

impl SyminfoFields

pub const BASE_CURRENCY: SyminfoFields

syminfo.basecurrency — index 0

pub const COUNTRY: SyminfoFields

syminfo.country — index 1

pub const CURRENCY: SyminfoFields

syminfo.currency — index 2

pub const CURRENT_CONTRACT: SyminfoFields

syminfo.current_contract — index 3

pub const DESCRIPTION: SyminfoFields

syminfo.description — index 4

pub const EMPLOYEES: SyminfoFields

syminfo.employees — index 5

pub const EXPIRATION_DATE: SyminfoFields

syminfo.expiration_date — index 6

pub const INDUSTRY: SyminfoFields

syminfo.industry — index 7

pub const ISIN: SyminfoFields

syminfo.isin — index 8

pub const MIN_CONTRACT: SyminfoFields

syminfo.mincontract — index 9

pub const MIN_MOVE: SyminfoFields

syminfo.minmove — index 10

pub const MIN_TICK: SyminfoFields

syminfo.mintick — index 11

pub const POINT_VALUE: SyminfoFields

syminfo.pointvalue — index 12

pub const PREFIX: SyminfoFields

syminfo.prefix — index 13

pub const PRICE_SCALE: SyminfoFields

syminfo.pricescale — index 14

pub const RECOMMENDATIONS_BUY: SyminfoFields

syminfo.recommendations_buy — index 15

pub const RECOMMENDATIONS_BUY_STRONG: SyminfoFields

syminfo.recommendations_buy_strong — index 16

pub const RECOMMENDATIONS_HOLD: SyminfoFields

syminfo.recommendations_hold — index 17

pub const RECOMMENDATIONS_SELL: SyminfoFields

syminfo.recommendations_sell — index 18

pub const RECOMMENDATIONS_SELL_STRONG: SyminfoFields

syminfo.recommendations_sell_strong — index 19

pub const RECOMMENDATIONS_DATE: SyminfoFields

syminfo.recommendations_date — index 20

pub const RECOMMENDATIONS_TOTAL: SyminfoFields

syminfo.recommendations_total — index 21

pub const ROOT: SyminfoFields

syminfo.root — index 22

pub const SECTOR: SyminfoFields

syminfo.sector — index 23

pub const SESSION: SyminfoFields

syminfo.session — index 24

pub const SHAREHOLDERS: SyminfoFields

syminfo.shareholders — index 25

pub const SHARES_OUTSTANDING_FLOAT: SyminfoFields

syminfo.shares_outstanding_float — index 26

pub const SHARES_OUTSTANDING_TOTAL: SyminfoFields

syminfo.shares_outstanding_total — index 27

pub const TARGET_PRICE_AVERAGE: SyminfoFields

syminfo.target_price_average — index 28

pub const TARGET_PRICE_DATE: SyminfoFields

syminfo.target_price_date — index 29

pub const TARGET_PRICE_ESTIMATES: SyminfoFields

syminfo.target_price_estimates — index 30

pub const TARGET_PRICE_HIGH: SyminfoFields

syminfo.target_price_high — index 31

pub const TARGET_PRICE_LOW: SyminfoFields

syminfo.target_price_low — index 32

pub const TARGET_PRICE_MEDIAN: SyminfoFields

syminfo.target_price_median — index 33

pub const TICKER: SyminfoFields

syminfo.ticker — index 34

pub const TICKERID: SyminfoFields

syminfo.tickerid — index 35

pub const TIMEZONE: SyminfoFields

syminfo.timezone — index 36

pub const TYPE: SyminfoFields

syminfo.type — index 37

pub const VOLUME_TYPE: SyminfoFields

syminfo.volumetype — index 38

pub const MAIN_TICKERID: SyminfoFields

syminfo.main_tickerid — index 39

impl SyminfoFields

pub const fn empty() -> SyminfoFields

Get a flags value with all bits unset.

pub const fn all() -> SyminfoFields

Get a flags value with all known bits set.

pub const fn bits(&self) -> u64

Get the underlying bits value.

The returned value is exactly the bits set in this flags value.

pub const fn from_bits(bits: u64) -> Option<SyminfoFields>

Convert from a bits value.

This method will return None if any unknown bits are set.

pub const fn from_bits_truncate(bits: u64) -> SyminfoFields

Convert from a bits value, unsetting any unknown bits.

pub const fn from_bits_retain(bits: u64) -> SyminfoFields

Convert from a bits value exactly.

pub fn from_name(name: &str) -> Option<SyminfoFields>

Get a flags value with the bits of a flag with the given name set.

This method will return None if name is empty or doesn’t correspond to any named flag.

pub const fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

pub const fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

pub const fn intersects(&self, other: SyminfoFields) -> bool

Whether any set bits in a source flags value are also set in a target flags value.

pub const fn contains(&self, other: SyminfoFields) -> bool

Whether all set bits in a source flags value are also set in a target flags value.

pub fn insert(&mut self, other: SyminfoFields)

The bitwise or (|) of the bits in two flags values.

pub fn remove(&mut self, other: SyminfoFields)

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. remove won’t truncate other, but the ! operator will.

pub fn toggle(&mut self, other: SyminfoFields)

The bitwise exclusive-or (^) of the bits in two flags values.

pub fn set(&mut self, other: SyminfoFields, value: bool)

Call insert when value is true or remove when value is false.

pub const fn intersection(self, other: SyminfoFields) -> SyminfoFields

The bitwise and (&) of the bits in two flags values.

pub const fn union(self, other: SyminfoFields) -> SyminfoFields

The bitwise or (|) of the bits in two flags values.

pub const fn difference(self, other: SyminfoFields) -> SyminfoFields

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

pub const fn symmetric_difference(self, other: SyminfoFields) -> SyminfoFields

The bitwise exclusive-or (^) of the bits in two flags values.

pub const fn complement(self) -> SyminfoFields

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl SyminfoFields

pub const fn iter(&self) -> Iter<SyminfoFields>

Yield a set of contained flags values.

Each yielded flags value will correspond to a defined named flag. Any unknown bits will be yielded together as a final flags value.

pub const fn iter_names(&self) -> IterNames<SyminfoFields>

Yield a set of contained named flags values.

This method is like iter, except only yields bits in contained named flags. Any unknown bits, or bits not corresponding to a contained flag will not be yielded.

impl SyminfoFields

pub fn from_syminfo_attr(name: &str) -> Option<SyminfoFields>

Map a field name (as used in @syminfo(name) attributes) to the corresponding bit. Returns None for unrecognised names.

Trait Implementations

impl Binary for SyminfoFields

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

Formats the value using the given formatter.

impl BitAnd for SyminfoFields

fn bitand(self, other: SyminfoFields) -> SyminfoFields

The bitwise and (&) of the bits in two flags values.

type Output = SyminfoFields

The resulting type after applying the & operator.

impl BitAndAssign for SyminfoFields

fn bitand_assign(&mut self, other: SyminfoFields)

The bitwise and (&) of the bits in two flags values.

impl BitOr for SyminfoFields

fn bitor(self, other: SyminfoFields) -> SyminfoFields

The bitwise or (|) of the bits in two flags values.

type Output = SyminfoFields

The resulting type after applying the | operator.

impl BitOrAssign for SyminfoFields

fn bitor_assign(&mut self, other: SyminfoFields)

The bitwise or (|) of the bits in two flags values.

impl BitXor for SyminfoFields

fn bitxor(self, other: SyminfoFields) -> SyminfoFields

The bitwise exclusive-or (^) of the bits in two flags values.

type Output = SyminfoFields

The resulting type after applying the ^ operator.

impl BitXorAssign for SyminfoFields

fn bitxor_assign(&mut self, other: SyminfoFields)

The bitwise exclusive-or (^) of the bits in two flags values.

impl Clone for SyminfoFields

fn clone(&self) -> SyminfoFields

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SyminfoFields

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

Formats the value using the given formatter.

impl Default for SyminfoFields

fn default() -> SyminfoFields

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SyminfoFields

fn deserialize<__D>( __deserializer: __D, ) -> Result<SyminfoFields, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Extend<SyminfoFields> for SyminfoFields

fn extend<T>(&mut self, iterator: T)

where T: IntoIterator<Item = SyminfoFields>,

The bitwise or (|) of the bits in each flags value.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl Flags for SyminfoFields

const FLAGS: &'static [Flag<SyminfoFields>]

The set of defined flags.

type Bits = u64

The underlying bits type.

fn bits(&self) -> u64

Get the underlying bits value.

fn from_bits_retain(bits: u64) -> SyminfoFields

Convert from a bits value exactly.

fn empty() -> Self

Get a flags value with all bits unset.

fn all() -> Self

Get a flags value with all known bits set.

fn contains_unknown_bits(&self) -> bool

This method will return true if any unknown bits are set.

fn from_bits(bits: Self::Bits) -> Option<Self>

Convert from a bits value.

fn from_bits_truncate(bits: Self::Bits) -> Self

Convert from a bits value, unsetting any unknown bits.

fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

fn iter(&self) -> Iter<Self>

Yield a set of contained flags values.

fn iter_names(&self) -> IterNames<Self>

Yield a set of contained named flags values.

fn iter_defined_names() -> IterDefinedNames<Self>

Yield a set of all named flags defined by [Self::FLAGS].

fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

fn intersects(&self, other: Self) -> bool

where Self: Sized,

Whether any set bits in a source flags value are also set in a target flags value.

fn contains(&self, other: Self) -> bool

where Self: Sized,

Whether all set bits in a source flags value are also set in a target flags value.

fn truncate(&mut self)

where Self: Sized,

Remove any unknown bits from the flags.

fn insert(&mut self, other: Self)

where Self: Sized,

The bitwise or (|) of the bits in two flags values.

fn remove(&mut self, other: Self)

where Self: Sized,

The intersection of a source flags value with the complement of a target flags value (&!).

fn toggle(&mut self, other: Self)

where Self: Sized,

The bitwise exclusive-or (^) of the bits in two flags values.

fn set(&mut self, other: Self, value: bool)

where Self: Sized,

Call [Flags::insert] when value is true or [Flags::remove] when value is false.

fn clear(&mut self)

where Self: Sized,

Unsets all bits in the flags.

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

The bitwise and (&) of the bits in two flags values.

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

The bitwise or (|) of the bits in two flags values.

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

The intersection of a source flags value with the complement of a target flags value (&!).

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

The bitwise exclusive-or (^) of the bits in two flags values.

fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl FromIterator<SyminfoFields> for SyminfoFields

fn from_iter<T>(iterator: T) -> SyminfoFields

where T: IntoIterator<Item = SyminfoFields>,

The bitwise or (|) of the bits in each flags value.

impl IntoIterator for SyminfoFields

type Item = SyminfoFields

The type of the elements being iterated over.

type IntoIter = Iter<SyminfoFields>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <SyminfoFields as IntoIterator>::IntoIter

Creates an iterator from a value.

impl LowerHex for SyminfoFields

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

Formats the value using the given formatter.

impl Not for SyminfoFields

fn not(self) -> SyminfoFields

The bitwise negation (!) of the bits in a flags value, truncating the result.

type Output = SyminfoFields

The resulting type after applying the ! operator.

impl Octal for SyminfoFields

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

Formats the value using the given formatter.

impl PartialEq for SyminfoFields

fn eq(&self, other: &SyminfoFields) -> 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 Serialize for SyminfoFields

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Sub for SyminfoFields

fn sub(self, other: SyminfoFields) -> SyminfoFields

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

type Output = SyminfoFields

The resulting type after applying the - operator.

impl SubAssign for SyminfoFields

fn sub_assign(&mut self, other: SyminfoFields)

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

impl UpperHex for SyminfoFields

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

Formats the value using the given formatter.

impl Copy for SyminfoFields

impl Eq for SyminfoFields

impl StructuralPartialEq for SyminfoFields