package util

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. util
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Package Members

  1. package syntax
  2. package timeline

Type Members

  1. trait AsLineOutput[T] extends AnyRef

    Typeclass for things that can be output to.

    Typeclass for things that can be output to. In order to output to an object of type T, it must be opened to some resource of type Opened and eventually have that resource be closed.

  2. trait AsString[-T] extends AnyRef

    Typeclass for things that are essentially strings (e.g., LimitedString).

  3. trait BaseGroupedBy[M[_, _], K, V, C[_]] extends AnyRef

    Base trait for GroupedBy and MutableGroupedBy

  4. trait BaseType[A] extends AnyRef
  5. trait BaseTypeEquiv[A, B] extends AnyRef
    Annotations
    @implicitNotFound("It looks like ${A} and ${B} don't have the same base type (even after unwrapping any Option layers)")
  6. trait BaseTypeLowPriority extends AnyRef
  7. trait CommutativeNumericCompanionPlatform[X[_]] extends EvidenceIterableFactory[X, Numeric]

    Scala 2.13-specific parts of the MathAggregations.XyzNumericCompanion trait.

    Scala 2.13-specific parts of the MathAggregations.XyzNumericCompanion trait. This interface is built up around EvidenceIterableFactory, which was added in scala 2.13, and which we are using instead of the now-deprecated CanBuildFrom typeclass.

  8. trait EventHandler[-E, S] extends AnyRef

    An event handler that responds to a given event in some implicitly-given scope.

    An event handler that responds to a given event in some implicitly-given scope. The handler can perform side-effects before deciding whether or not interrupt the event, which would prevent the event from being passed to any more handlers.

    E

    The event type

    S

    The scope type, e.g. a Transaction, or Unit for unscoped events

  9. sealed trait EventHandlerAction extends AnyRef

    Indicates a decision by an EventHandler to either interrupt the event (preventing it from being passed to further event handlers), or allow it to continue.

  10. class EventHandlerRegistry[S] extends AnyRef

    An instance of this class is able to register "EventHandlers" and dispatch events to them.

    An instance of this class is able to register "EventHandlers" and dispatch events to them. Events will be dispatched to handlers in the order they were added. In addition to the event itself, a scope (e.g. a Transaction) can be provided to the handler.

    S

    The scope type

  11. trait EventSubscription extends AnyRef
  12. case class FilePath(name: String, parent: Option[FilePath]) extends Ordered[FilePath] with Product with Serializable

    A representation of a FilePath, made of a series of path segments, ending with a name.

    A representation of a FilePath, made of a series of path segments, ending with a name. A FilePath is represented in memory as a "name" (the final part of the path), and an optional reference to a parent. In this manner, it is comparable to a scala List, except that it is reversed.

    The purpose of this class is to represent the same thing as a java.io.File or a java.nio.file.Path, but without the intention of actually interacting with any filesystem. FilePath is purely representational data.

  13. trait FilenameSanitization extends AnyRef

    Utility mixin that includes methods for sanitizing filenames and paths for use in an actual filesystem.

  14. case class GroupedBy[K, V, C[_]](map: Map[K, C[V]]) extends BaseGroupedBy[Map, K, V, C] with Product with Serializable

    Type wrapper for a Map of "key to collection of values", i.e.

    Type wrapper for a Map of "key to collection of values", i.e. the result of a groupBy call. Works with Slick's Invoker#build method to build up a map from a streaming result set.

    Created by DylanH on 6/26/2017.

    K

    The key type

    V

    The value type

    C

    The type of the collection to hold values in the map

  15. trait GroupedByPlatform extends AnyRef

    Used to split the scala 2.13-only parts of the GroupedBy object.

    Used to split the scala 2.13-only parts of the GroupedBy object. The implicits for creating new Builder are oriented around IterableFactory and MapFactory, replacing the usage of the now-removed CanBuildFrom trait.

  16. class LazyMap[K, V] extends AnyRef

    Simple cache-like class that will lazily initialize values for any given key.

  17. case class MutableGroupedBy[K, V, C[_]](map: Map[K, C[V]]) extends BaseGroupedBy[Map, K, V, C] with Product with Serializable

    Variant of GroupedBy that uses a *mutable* map

  18. class NonEmptyIterable[+A] extends AnyRef
  19. trait OnlyTraversable[A] extends AnyRef

    Push-style "stream" which fills the void left by the removal of Traversable in Scala 2.13.

    Push-style "stream" which fills the void left by the removal of Traversable in Scala 2.13.

    This is kind of a niche for the handful of cases where we want to treat something as "collection" but writing an iterator would be too difficult. I.e. when the collection contents are determined by some algorithm that reports results via a side-effect, such as the Bron-Kerbosch algorithm.

    An OnlyTraversable can only be traversed by its foreach method; it has no iterator. It can be transformed via the typical for-comprehension methods, but no other conveniences are provided.

  20. trait OptionBaseType[T] extends AnyRef
  21. trait OptionBaseTypeLowPriority extends AnyRef
  22. class SimpleIOAdapter[T] extends AnyRef

    A basic I/O adapter for capturing and applying a transformation to a process's stdout while capturing stderr from that process.

  23. trait StringMatcher[T] extends AnyRef

    Oh how I wish Scala already had a trait for unapply objects.

    Oh how I wish Scala already had a trait for unapply objects. (Note: Inject from Cats fits the bill, but since this module is supposed to be dependency-free, we can't use it here)

  24. trait StringMatcherPlatform extends AnyRef

    Used to split scala 2.12-only interfaces out of the StringMatcher companion object.

    Used to split scala 2.12-only interfaces out of the StringMatcher companion object. The commaSeparated/tokenSeparated helpers use an implicit Factory[_, _], replacing the now-unavailable CanBuildFrom[Nothing, _, _] that was used in 2.12.

  25. trait SyncResource[+R] extends AnyRef

    Abstraction that's *close* to cats.effect.Resource[R], but is suitable for adapting uses where the acquisition and release of the resource are joined together in a block (i.e.

    Abstraction that's *close* to cats.effect.Resource[R], but is suitable for adapting uses where the acquisition and release of the resource are joined together in a block (i.e. they can't be separated for use in constructing a Resource).

    R

    The acquired resource type

  26. type UnitK[x] = Unit

    Useful for when you need a FunctionK where the output type is only ever Unit, e.g.

    Useful for when you need a FunctionK where the output type is only ever Unit, e.g. calling foreach on a MapK.

  27. case class Version(v: String) extends Ordered[Version] with Product with Serializable

    This a comparable (with >,<,==) version String helper.

    This a comparable (with >,<,==) version String helper. It should be able to handle most version Strings within reason. It will try to pull out the first group of digits separated by '.'s and convert it to a List of Int for comparison. It also searches for a release candidate version at the end of the String that's formatted as "...-rc#[EOL]". If a version isn't matched, it will be treated as if it was '0' and isValid will be false.

    One thing to note with that limitation is that it won't parse a single digit String. This is because with the regex it uses, it needs to have some sort of anchor to tell that the digit it's looking at is actually part of a valid version number. If it matched for \d+(\.\d+)* instead, it would end up the same as \d+ since the second term is optional

    Created by RyanM on 1/11/2017.

Value Members

  1. object AsLineOutput
  2. object AsString
  3. object AsVersion

    A simple little helper for dealing with version number strings (a set of dot-delimited integers).

  4. object BaseType extends BaseTypeLowPriority
  5. object BaseTypeEquiv
  6. object CaseConversions
  7. object EventHandlerAction
  8. object FilePath extends Serializable
  9. object FilenameSanitization extends FilenameSanitization

    Singleton version of the FilenameSanitization mixin.

  10. object GroupedBy extends GroupedByPlatform with Serializable
  11. object LogToolOutput

    Helper for logging output from tools.

  12. object MathAggregations

    A few pseudo-collections for numbers to provide some basic aggregations (like sum and average).

    A few pseudo-collections for numbers to provide some basic aggregations (like sum and average). This is envisioned to be used with GroupedBy to prevent needing to collect all of the numbers and apply the operation after, at least for operations that can be aggregated on the fly.

  13. object NonEmptyIterable
  14. object OnlyTraversable
  15. object OptionBaseType extends OptionBaseTypeLowPriority
  16. object SimpleIOAdapter
  17. object StringMatcher extends StringMatcherPlatform
  18. object SyncResource
  19. object UrlUtils

    Created by ryanm on 6/14/2017.

Inherited from AnyRef

Inherited from Any

Ungrouped