InferBorrowKind in rustc_hir_typeck::upvar - Rust
Description: API documentation for the Rust `InferBorrowKind` struct in crate `rustc_hir_typeck`.

Skip to main content

## InferBorrowKind

# Struct InferBorrowKind

Source

    struct InferBorrowKind<'a, 'tcx> {
        fcx: &'a FnCtxt<'a, 'tcx>,
        closure_def_id: LocalDefId,
        capture_information: Vec<(Place<'tcx>, CaptureInfo)>,
        fake_reads: Vec<(Place<'tcx>, FakeReadCause, HirId)>,
    }

## Fields§

§`fcx: &'a FnCtxt<'a, 'tcx>`§`closure_def_id: LocalDefId`§`capture_information: Vec<(Place<'tcx>, CaptureInfo)>`

For each Place that is captured by the closure, we track the minimal kind of access we need (ref, ref mut, move, etc) and the expression that resulted in such access.

Consider closure where s.str1 is captured via an ImmutableBorrow and s.str2 via a MutableBorrow

    struct SomeStruct { str1: String, str2: String };

    // Assume that the HirId for the variable definition is `V1`
    let mut s = SomeStruct { str1: format!("s1"), str2: format!("s2") };

    let fix_s = |new_s2| {
        // Assume that the HirId for the expression `s.str1` is `E1`
        println!("Updating SomeStruct with str1={0}", s.str1);
        // Assume that the HirId for the expression `*s.str2` is `E2`
        s.str2 = new_s2;
    };

For closure `fix_s`, (at a high level) the map contains

ⓘ

    Place { V1, [ProjectionKind::Field(Index=0, Variant=0)] } : CaptureKind { E1, ImmutableBorrow }
    Place { V1, [ProjectionKind::Field(Index=1, Variant=0)] } : CaptureKind { E2, MutableBorrow }

§`fake_reads: Vec<(Place<'tcx>, FakeReadCause, HirId)>`

## Trait Implementations§

Source§

### impl<'a, 'tcx> Delegate<'tcx> for InferBorrowKind<'a, 'tcx>

Source§

#### fn fake_read( &mut self, place_with_id: &PlaceWithHirId<'tcx>, cause: FakeReadCause, diag_expr_id: HirId, )

The `place` should be a fake read because of specified `cause`.
Source§

#### fn consume(&mut self, place_with_id: &PlaceWithHirId<'tcx>, diag_expr_id: HirId)

The value found at `place` is moved, depending on `mode`. Where `diag_expr_id` is the id used for diagnostics for `place`. Read more
Source§

#### fn use_cloned( &mut self, place_with_id: &PlaceWithHirId<'tcx>, diag_expr_id: HirId, )

The value found at `place` is used, depending on `mode`. Where `diag_expr_id` is the id used for diagnostics for `place`. Read more
Source§

#### fn borrow( &mut self, place_with_id: &PlaceWithHirId<'tcx>, diag_expr_id: HirId, bk: BorrowKind, )

The value found at `place` is being borrowed with kind `bk`. `diag_expr_id` is the id used for diagnostics (see `consume` for more details).
Source§

#### fn mutate(&mut self, assignee_place: &PlaceWithHirId<'tcx>, diag_expr_id: HirId)

The path at `assignee_place` is being assigned to. `diag_expr_id` is the id used for diagnostics (see `consume` for more details).
Source§

#### fn copy(&mut self, place_with_id: &PlaceWithHirId<'tcx>, diag_expr_id: HirId)

The value found at `place` is being copied. `diag_expr_id` is the id used for diagnostics (see `consume` for more details). Read more
Source§

#### fn bind(&mut self, binding_place: &PlaceWithHirId<'tcx>, diag_expr_id: HirId)

The path at `binding_place` is a binding that is being initialized. Read more

## Auto Trait Implementations§

§

### impl<'a, 'tcx> !DynSend for InferBorrowKind<'a, 'tcx>

§

### impl<'a, 'tcx> !DynSync for InferBorrowKind<'a, 'tcx>

§

### impl<'a, 'tcx> Freeze for InferBorrowKind<'a, 'tcx>

§

### impl<'a, 'tcx> !RefUnwindSafe for InferBorrowKind<'a, 'tcx>

§

### impl<'a, 'tcx> !Send for InferBorrowKind<'a, 'tcx>

§

### impl<'a, 'tcx> !Sync for InferBorrowKind<'a, 'tcx>

§

### impl<'a, 'tcx> Unpin for InferBorrowKind<'a, 'tcx>

§

### impl<'a, 'tcx> UnsafeUnpin for InferBorrowKind<'a, 'tcx>

§

### impl<'a, 'tcx> !UnwindSafe for InferBorrowKind<'a, 'tcx>

## Blanket Implementations§

Source§

### impl<T> Aligned for T

Source§

#### const ALIGN: Alignment

Alignment of `Self`.
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, R> CollectAndApply<T, R> for T

Source§

#### fn collect_and_apply<I, F>(iter: I, f: F) -> R
where I: Iterator<Item = T>, F: FnOnce(&[T]) -> R,

Equivalent to `f(&iter.collect::<Vec<_>>())`.

Source§

#### type Output = R

Source§

### impl<T> From<T> for T

Source§

#### fn from(t: T) -> T

Returns the argument unchanged.

Source§

### impl<T> Instrument for T

Source§

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

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

#### 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<K> IntoQueryKey<K> for K

Source§

#### fn into_query_key(self) -> K

Argument conversion from `Self` to `K`. This should always be a very cheap conversion, e.g. `LocalDefId::to_def_id`.
Source§

### impl<T> MaybeResult<T> for T

Source§

#### type Error = !

Source§

#### fn from(_: Result<T, <T as MaybeResult<T>>::Error>) -> T

Source§

#### fn to_result(self) -> Result<T, <T as MaybeResult<T>>::Error>

Source§

### impl<T> Pointable for T

Source§

#### const ALIGN: usize

The alignment of pointer.
Source§

#### type Init = T

The type for initializers.
Source§

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

Initializes a with the given initializer. Read more
Source§

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

Dereferences the given pointer. Read more
Source§

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

Mutably dereferences the given pointer. Read more
Source§

#### unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. 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.
Source§

### impl<I, T, U> Upcast<I, U> for T
where U: UpcastFrom<I, T>,

Source§

#### fn upcast(self, interner: I) -> U

Source§

### impl<I, T> UpcastFrom<I, T> for T

Source§

#### fn upcast_from(from: T, _tcx: I) -> T

Source§

### impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

#### fn vzip(self) -> V

Source§

### impl<T> WithSubscriber for T

Source§

#### 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
Source§

#### fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default `Subscriber` to this type, returning a `WithDispatch` wrapper. Read more
Source§

### impl<T> ErasedDestructor for T
where T: 'static,

## Layout§

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain `repr(...)` attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 64 bytes