Skip to main content

PlacementBuilder

Struct PlacementBuilder 

Source
pub struct PlacementBuilder<'p, 'a> {
    grid: &'p mut GridPlacer<'a>,
    rect: Rect,
    container: ContainerRef,
    mapping: SlotMapping,
    kind: SectionKind,
}
Expand description

A pending placement, applied only when region or result is called.

Fields§

§grid: &'p mut GridPlacer<'a>§rect: Rect§container: ContainerRef§mapping: SlotMapping§kind: SectionKind

Implementations§

Source§

impl PlacementBuilder<'_, '_>

Source

pub fn start_at(self, slot: usize) -> Self

Maps the rect’s first cell to container slot slot instead of 0.

Source

pub fn at_indices(self, indices: impl IntoIterator<Item = usize>) -> Self

Maps the rect’s cells (row-major) to these container slots, in the given order. Replaces start_at.

The committing call panics if the count differs from the rect’s cell count.

Source

pub fn kind(self, kind: impl Into<SectionKind>) -> Self

Lowers the cells through kind, e.g. a SectionKind::Custom factory. The generalization of restrict, guard and display.

Source

pub fn restrict( self, may_place: impl Fn(usize, &ItemStack) -> bool + Send + Sync + 'static, ) -> Self

Only accepts items passing may_place. Pickup stays allowed.

Source

pub fn guard( self, may_place: impl Fn(usize, &ItemStack) -> bool + Send + Sync + 'static, may_pickup: impl Fn(usize, &ItemStack, &ContainerLockGuard, &Player) -> bool + Send + Sync + 'static, ) -> Self

Guards both placement and pickup.

Source

pub fn display(self) -> Self

Locks the cells as display slots. Clicks are rejected and handled in MenuKind::on_slot_clicked.

Source

pub fn region(self) -> Region

Commits the placement and returns its region.

Source

pub fn section(self) -> Section

Commits the placement and returns its single contiguous Section.

Shorthand for region() followed by Region::single; use region() when the rect may lower to multiple slot ranges.

§Panics

Panics if the placement lowers to more than one contiguous slot range. Single-cell and single-row rects can never trip this.

Source

pub fn result(self, handler: impl ResultHandler + 'static) -> Section

Commits a single fake result slot driven by handler, ignoring start_at and guards.

§Panics

If the rect is not a single cell, or the placement container differs from ResultHandler::result_container.

Auto Trait Implementations§

§

impl<'p, 'a> !RefUnwindSafe for PlacementBuilder<'p, 'a>

§

impl<'p, 'a> !UnwindSafe for PlacementBuilder<'p, 'a>

§

impl<'p, 'a> Freeze for PlacementBuilder<'p, 'a>

§

impl<'p, 'a> Send for PlacementBuilder<'p, 'a>

§

impl<'p, 'a> Sync for PlacementBuilder<'p, 'a>

§

impl<'p, 'a> Unpin for PlacementBuilder<'p, 'a>

§

impl<'p, 'a> UnsafeUnpin for PlacementBuilder<'p, 'a>

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

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

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.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts 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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts 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 more
Source§

impl<T> IntoShared for T

Source§

fn into_shared(self) -> Arc<Mutex<RawMutex, Self>>

Wraps this value in an Arc<SyncMutex<>>
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

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

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more