Struct rune::Warnings

pub struct Warnings { /* fields omitted */ }

Compilation warnings.

Implementations

impl Warnings

pub fn disabled() -> Self

Construct a new, empty collection of compilation warnings that is disabled, i.e. any warnings added to it will be ignored.

Examples

use rune::Warnings;
use runestick::Span;

let mut warnings = Warnings::disabled();
assert!(warnings.is_empty());
warnings.not_used(0, Span::empty(), None);

pub fn new() -> Self

Construct a new, empty collection of compilation warnings.

Examples

use rune::{Warnings, Warning, WarningKind};
use runestick::Span;

let mut warnings = Warnings::new();
assert!(warnings.is_empty());
warnings.not_used(0, Span::empty(), None);
assert!(!warnings.is_empty());

assert!(matches!(warnings.iter().next(), Some(Warning { source_id: 0, kind: WarningKind::NotUsed { .. } })));

pub fn is_empty(&self) -> bool

Indicate if there are warnings or not.

pub fn iter(&self) -> impl Iterator<Item = &Warning>

Get an iterator over all the warnings.

pub fn not_used(&mut self, source_id: usize, span: Span, context: Option<Span>)

Indicate that a value is produced but never used.

pub fn let_pattern_might_panic(
    &mut self,
    source_id: usize,
    span: Span,
    context: Option<Span>
)

Indicate that a binding pattern might panic.

Like let (a, b) = value.

pub fn template_without_expansions(
    &mut self,
    source_id: usize,
    span: Span,
    context: Option<Span>
)

Indicate that we encountered a template string without any expansion groups.

Like `Hello`.

pub fn remove_tuple_call_parens(
    &mut self,
    source_id: usize,
    span: Span,
    variant: Span,
    context: Option<Span>
)

Add a warning indicating that the parameters of an empty tuple can be removed when creating it.

Like None().

pub fn uneccessary_semi_colon(&mut self, source_id: usize, span: Span)

Add a warning about an unecessary semi-colon.

Trait Implementations

impl Clone for Warnings

fn clone(&self) -> Warnings

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Warnings

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

Formats the value using the given formatter.

impl Default for Warnings

fn default() -> Warnings

Returns the "default value" for a type.

impl<'a> IntoIterator for &'a Warnings

type IntoIter = Iter<'a, Warning>

Which kind of iterator are we turning this into?

type Item = &'a Warning

The type of the elements being iterated over.

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.