Struct starlark::values::docs::DocString

source · [−]

pub struct DocString {
    pub summary: String,
    pub details: Option<String>,
}

Expand description

The documentation provided by a user for a specific module, object, function, etc.

Fields

summary: String

The first line of a doc string. This has whitespace trimmed from it.

details: Option<String>

The contents of a doc string that follow the summary, and a single blank line. This also has whitespace trimmed from it, and it is dedented.

Implementations

impl DocString

pub fn extract_raw_starlark_docstring<P: AstPayload>(
body: &Spanned<StmtP<P>>
) -> Option<String>

Extracts the docstring from a function or module body, iff the first statement is a string literal.

pub fn from_docstring(
kind: DocStringKind,
user_docstring: &str
) -> Option<DocString>

Do common work to parse a docstring (dedenting, splitting summary and details, etc)

pub fn parse_params(
kind: DocStringKind,
args_section: &str
) -> HashMap<String, String>

Parse out parameter docs from an “Args:” section of a docstring

args_section should be dedented, and generally should just be the args key of the DocString::parse_params() function call. This is done as a separate function to reduce the number of times that sections are parsed out of docstring (e.g. if a user wants both the Args: and Returns: sections)

Trait Implementations

impl Clone for DocString

fn clone(&self) -> DocString

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

impl Debug for DocString

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

Formats the value using the given formatter. Read more

impl<'de> Deserialize<'de> for DocString

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
__D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

impl PartialEq<DocString> for DocString

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

This method tests for self and other values to be equal, and is used by ==. Read more

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

This method tests for !=.

impl Serialize for DocString

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
S: Serializer,

Serialize this value into the given Serde serializer. Read more

impl<'v> Trace<'v> for DocString

fn trace(&mut self, tracer: &Tracer<'v>)

Recursively “trace” the value. Read more

impl StructuralPartialEq for DocString

Auto Trait Implementations

impl RefUnwindSafe for DocString

impl Send for DocString

impl Sync for DocString

impl Unpin for DocString

impl UnwindSafe for DocString

Blanket Implementations

impl<T> Any for T where
T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> AsARef<T> for T where
T: ?Sized,

fn as_aref(this: &T) -> ARef<'_, T>

Get an ARef pointing at this type.

fn try_as_aref(this: &T) -> Result<ARef<'_, T>, BorrowError>

Try and get an ARef pointing at this type. Returns an Err if the type Self is a RefCell which is already mutably borrowed. Read more

fn as_ref_cell(_this: &T) -> Option<&RefCell<T>>

Return the underlying RefCell if Self is one, otherwise None.

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> Serialize for T where
T: Serialize + ?Sized,

fn erased_serialize(&self, serializer: &mut dyn Serializer) -> Result<Ok, Error>

impl<T> TEq<T> for T

fn teq(self) -> T

Convert between two equal types.

fn teq_ref(&self) -> &T

Convert between references to two equal types.

fn teq_mut(&mut self) -> &mut T

Convert between mutable references to two equal types.

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

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

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,