Uncons

java.lang.Object
- com.jnape.palatable.lambda.functions.builtin.fn1.Uncons<A>

Type Parameters:

A - the Iterable element type

All Implemented Interfaces:

Fn1<java.lang.Iterable<A>,Maybe<Tuple2<A,java.lang.Iterable<A>>>>, Applicative<Maybe<Tuple2<A,java.lang.Iterable<A>>>,Fn1<java.lang.Iterable<A>,?>>, Cartesian<java.lang.Iterable<A>,Maybe<Tuple2<A,java.lang.Iterable<A>>>,Fn1<?,?>>, Cocartesian<java.lang.Iterable<A>,Maybe<Tuple2<A,java.lang.Iterable<A>>>,Fn1<?,?>>, Contravariant<java.lang.Iterable<A>,Profunctor<?,Maybe<Tuple2<A,java.lang.Iterable<A>>>,Fn1<?,?>>>, Functor<Maybe<Tuple2<A,java.lang.Iterable<A>>>,Fn1<java.lang.Iterable<A>,?>>, Profunctor<java.lang.Iterable<A>,Maybe<Tuple2<A,java.lang.Iterable<A>>>,Fn1<?,?>>, Monad<Maybe<Tuple2<A,java.lang.Iterable<A>>>,Fn1<java.lang.Iterable<A>,?>>, MonadReader<java.lang.Iterable<A>,Maybe<Tuple2<A,java.lang.Iterable<A>>>,Fn1<java.lang.Iterable<A>,?>>, MonadRec<Maybe<Tuple2<A,java.lang.Iterable<A>>>,Fn1<java.lang.Iterable<A>,?>>, MonadWriter<java.lang.Iterable<A>,Maybe<Tuple2<A,java.lang.Iterable<A>>>,Fn1<java.lang.Iterable<A>,?>>
```
public final class Uncons<A>
extends java.lang.Object
implements Fn1<java.lang.Iterable<A>,Maybe<Tuple2<A,java.lang.Iterable<A>>>>
```
Destructure an Iterable into a Tuple2 of its head and tail, wrapped in an Maybe. If the Iterable is empty, returns Maybe.nothing().

Field Summary

Fields
Modifier and Type Field Description

private static Uncons<?> INSTANCE

Constructor Summary

Constructors
Modifier Constructor Description

private Uncons()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Maybe<Tuple2<A,java.lang.Iterable<A>>>`	`checkedApply(java.lang.Iterable<A> as)`	Invoke this function with the given argument, potentially throwing any `Throwable`.
`static <A> Uncons<A>`	`uncons()`
`static <A> Maybe<Tuple2<A,java.lang.Iterable<A>>>`	`uncons(java.lang.Iterable<A> as)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.jnape.palatable.lambda.functions.Fn1
andThen, apply, carry, cartesian, censor, choose, cocartesian, compose, contraMap, diMap, diMapL, diMapR, discardL, discardR, flatMap, fmap, lazyZip, listens, local, pure, self, thunk, toFunction, trampolineM, widen, zip, zip

Methods inherited from interface com.jnape.palatable.lambda.functor.Functor
coerce

- Field Detail
  - INSTANCE
```
private static final Uncons<?> INSTANCE
```
- Constructor Detail
  - Uncons
```
private Uncons()
```
- Method Detail
  - checkedApply
```
public Maybe<Tuple2<A,java.lang.Iterable<A>>> checkedApply(java.lang.Iterable<A> as)
```
    Description copied from interface: Fn1
    
    Invoke this function with the given argument, potentially throwing any Throwable.
    
    Specified by:
    
    checkedApply in interface Fn1<java.lang.Iterable<A>,Maybe<Tuple2<A,java.lang.Iterable<A>>>>
    
    Parameters:
    
    as - the argument
    
    Returns:
    
    the result of the function application
  - uncons
```
public static <A> Uncons<A> uncons()
```
  - uncons
```
public static <A> Maybe<Tuple2<A,java.lang.Iterable<A>>> uncons(java.lang.Iterable<A> as)
```