Struct Review 

pub struct Review<'a, PointerBrand, S, T, A, B>
where
    PointerBrand: UnsizedCoercible,
    S: 'a,
    T: 'a,
    A: 'a,
    B: 'a,
{
    pub review_fn: <FnBrand<PointerBrand> as Kind_266801a817966495>::Of<'a, B, T>,
    /* private fields */
}

A polymorphic review.

Matches PureScript’s Review s t a b.

Type Parameters

• 'a: The lifetime of the values.
• PointerBrand: The reference-counted pointer type.
• S: The source type of the structure.
• T: The target type of the structure.
• A: The source type of the focus.
• B: The target type of the focus.

Fields

review_fn: <FnBrand<PointerBrand> as Kind_266801a817966495>::Of<'a, B, T>

Function to construct a structure from a focus value.

Implementations

impl<'a, PointerBrand, S, T, A, B> Review<'a, PointerBrand, S, T, A, B>

where PointerBrand: UnsizedCoercible, S: 'a, T: 'a, A: 'a, B: 'a,

Type Parameters

• 'a: The lifetime of the values.
• PointerBrand: The reference-counted pointer type.
• S: The source type of the structure.
• T: The target type of the structure.
• A: The source type of the focus.
• B: The target type of the focus.

pub fn new(review: impl 'a + Fn(B) -> T) -> Self

Create a new polymorphic review from a review function.

Type Signature

forall PointerBrand S T A B. UnsizedCoercible PointerBrand => (B -> T) -> Review PointerBrand S T A B

Parameters

• review: The review function.

Returns

A new instance of the type.

Examples

use fp_library::{
	brands::RcBrand,
	types::optics::Review,
};

let r: Review<RcBrand, Option<i32>, Option<i32>, i32, i32> = Review::new(Some);
assert_eq!(r.review(42), Some(42));

pub fn review(&self, b: B) -> T

Review a focus value into a structure.

Type Signature

forall PointerBrand S T A B. UnsizedCoercible PointerBrand => (&Review PointerBrand S T A B, B) -> T

Parameters

• &self: The review instance.
• b: The focus value to review.

Returns

The structure containing the focus value.

Examples

use fp_library::{
	brands::RcBrand,
	types::optics::Review,
};

let r: Review<RcBrand, Option<i32>, Option<i32>, i32, i32> = Review::new(Some);
assert_eq!(r.review(42), Some(42));

Trait Implementations

impl<'a, PointerBrand, S, T, A, B> Clone for Review<'a, PointerBrand, S, T, A, B>

where PointerBrand: UnsizedCoercible, S: 'a, T: 'a, A: 'a, B: 'a,

Type Parameters

• 'a: The lifetime of the values.
• PointerBrand: The reference-counted pointer type.
• S: The source type of the structure.
• T: The target type of the structure.
• A: The source type of the focus.
• B: The target type of the focus.

fn clone(&self) -> Self

Type Signature

forall PointerBrand S T A B. UnsizedCoercible PointerBrand => &Review PointerBrand S T A B -> Review PointerBrand S T A B

Returns

A new Review instance that is a copy of the original.

Examples

use fp_library::{
	brands::RcBrand,
	types::optics::Review,
};

let r: Review<RcBrand, Option<i32>, Option<i32>, i32, i32> = Review::new(Some);
let cloned = r.clone();
assert_eq!(cloned.review(42), Some(42));

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

Performs copy-assignment from source.

impl<'a, PointerBrand, S, T, A, B> Optic<'a, TaggedBrand, S, T, A, B> for Review<'a, PointerBrand, S, T, A, B>

where PointerBrand: UnsizedCoercible, S: 'a, T: 'a, A: 'a, B: 'a,

Type Parameters

• 'a: The lifetime of the values.
• PointerBrand: The reference-counted pointer type.
• S: The source type of the structure.
• T: The target type of the structure.
• A: The source type of the focus.
• B: The target type of the focus.

fn evaluate( &self, pab: <TaggedBrand as Kind_266801a817966495>::Of<'a, A, B>, ) -> <TaggedBrand as Kind_266801a817966495>::Of<'a, S, T>

Type Signature

forall PointerBrand S T A B. UnsizedCoercible PointerBrand => (&Review PointerBrand S T A B, Tagged A B) -> Tagged S T

Parameters

• &self: The review instance.
• pab: The profunctor value to transform.

Returns

The transformed profunctor value.

Examples

use fp_library::{
	brands::{
		optics::*,
		*,
	},
	classes::optics::*,
	functions::*,
	types::optics::*,
};

let r: Review<RcBrand, Option<i32>, Option<i32>, i32, i32> = Review::new(Some);
let f = Tagged::new(42);
let reviewed = Optic::<TaggedBrand, _, _, _, _>::evaluate(&r, f);
assert_eq!(reviewed.0, Some(42));

impl<'a, PointerBrand, S, T, A, B> ReviewOptic<'a, S, T, A, B> for Review<'a, PointerBrand, S, T, A, B>

where PointerBrand: UnsizedCoercible, S: 'a, T: 'a, A: 'a, B: 'a,

Type Parameters

• 'a: The lifetime of the values.
• PointerBrand: The reference-counted pointer type.
• S: The source type of the structure.
• T: The target type of the structure.
• A: The source type of the focus.
• B: The target type of the focus.

fn evaluate( &self, pab: <TaggedBrand as Kind_266801a817966495>::Of<'a, A, B>, ) -> <TaggedBrand as Kind_266801a817966495>::Of<'a, S, T>

Type Signature

forall PointerBrand S T A B. UnsizedCoercible PointerBrand => (&Review PointerBrand S T A B, Tagged A B) -> Tagged S T

Parameters

• &self: The review instance.
• pab: The profunctor value to transform.

Returns

The transformed profunctor value.

Examples

use fp_library::{
	brands::{
		optics::*,
		*,
	},
	classes::optics::*,
	functions::*,
	types::optics::*,
};

let r: Review<RcBrand, Option<i32>, Option<i32>, i32, i32> = Review::new(Some);
let f = Tagged::new(42);
let reviewed = ReviewOptic::evaluate(&r, f);
assert_eq!(reviewed.0, Some(42));