You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+52-52
Original file line number
Diff line number
Diff line change
@@ -15,105 +15,105 @@ A curated collection of idiomatic design & application patterns for Go language.
15
15
16
16
| Pattern | Description | Status |
17
17
|:-------:|:----------- |:------:|
18
-
|[Abstract Factory](creational/abstract_factory.md)| Provides an interface for creating families of releated objects | ✘ |
19
-
|[Builder](creational/builder.md)| Builds a complex object using simple objects | ✘ |
20
-
|[Factory Method](creational/factory.md)| Defers instantiation of an object to a specialized function for creating instances | ✘ |
21
-
|[Object Pool](creational/object_pool.md)| Instantiates and maintains a group of objects instances of the same type | ✔ |
22
-
|[Singleton](creational/singleton.md)| Restricts instantiation of a type to one object | ✔ |
18
+
|[Abstract Factory](/creational/abstract_factory.md)| Provides an interface for creating families of releated objects | ✘ |
19
+
|[Builder](/creational/builder.md)| Builds a complex object using simple objects | ✘ |
20
+
|[Factory Method](/creational/factory.md)| Defers instantiation of an object to a specialized function for creating instances | ✘ |
21
+
|[Object Pool](/creational/object_pool.md)| Instantiates and maintains a group of objects instances of the same type | ✔ |
22
+
|[Singleton](/creational/singleton.md)| Restricts instantiation of a type to one object | ✔ |
23
23
24
24
## Structural Patterns
25
25
26
26
| Pattern | Description | Status |
27
27
|:-------:|:----------- |:------:|
28
-
|[Adapter](structural/.md)| Adapts otherwise incompatible interfaces to work together by adapting one to the other | ✘ |
29
-
|[Bridge](structural/bridge.md)| Decouples an interface from its implementation so that the two can vary independently | ✘ |
30
-
|[Composite](structural/composite.md)| Encapsulates and provides access to a number of different objects | ✘ |
31
-
|[Decorator](structural/decorator.md)| Adds behavior to an object, statically or dynamically | ✔ |
32
-
|[Facade](structural/facade.md)| Uses one type as an API to a number of others | ✘ |
33
-
|[Flyweight](structural/flyweight.md)| Reuses existing instances of objects with similar/identical state to minimize resource usage | ✘ |
34
-
|[Model View Controller](structural/model_view_controller.md)| Divides an app into three interconnected parts to separate internal representation from presentation to user | ✘ |
35
-
|[Proxy](structural/proxy.md)| Provides a surrogate for an object to control it's actions | ✘ |
28
+
|[Adapter](/structural/adapter.md)| Adapts otherwise incompatible interfaces to work together by adapting one to the other | ✘ |
29
+
|[Bridge](/structural/bridge.md)| Decouples an interface from its implementation so that the two can vary independently | ✘ |
30
+
|[Composite](/structural/composite.md)| Encapsulates and provides access to a number of different objects | ✘ |
31
+
|[Decorator](/structural/decorator.md)| Adds behavior to an object, statically or dynamically | ✔ |
32
+
|[Facade](/structural/facade.md)| Uses one type as an API to a number of others | ✘ |
33
+
|[Flyweight](/structural/flyweight.md)| Reuses existing instances of objects with similar/identical state to minimize resource usage | ✘ |
34
+
|[Model View Controller](/structural/model_view_controller.md)| Divides an app into three interconnected parts to separate internal representation from presentation to user | ✘ |
35
+
|[Proxy](/structural/proxy.md)| Provides a surrogate for an object to control it's actions | ✘ |
36
36
37
37
## Behavioral Patterns
38
38
39
39
| Pattern | Description | Status |
40
40
|:-------:|:----------- |:------:|
41
-
|[Chain of Responsibility](behavioral/chain_of_responsibility.md)| Avoids coupling a sender to receiver by giving more than object a chance to handle the request | ✘ |
42
-
|[Command](behavioral/command.md)| Bundles a command and arguments to call later | ✘ |
43
-
|[Mediator](behavioral/mediator.md)| Connects objects and acts as a proxy | ✘ |
44
-
|[Memento](behavioral/memento.md)| Generate an opaque token that can be used to go back to a previous state | ✘ |
45
-
|[Observer](behavioral/observer.md)| Provide a callback for notification of events/changes to data | ✔ |
46
-
|[Registry](behavioral/registry.md)| Keep track of all subclasses of a given class | ✘ |
47
-
|[State](behavioral/state.md)| Encapsulates varying behavior for the same object based on its internal state | ✘ |
48
-
|[Strategy](behavioral/strategy.md)| Enables an algorithm's behavior to be selected at runtime | ✔ |
49
-
|[Template](behavioral/template.md)| Defines a skeleton class which defers some methods to subclasses | ✘ |
50
-
|[Visitor](behavioral/visitor.md)| Separates an algorithm from an object on which it operates | ✘ |
41
+
|[Chain of Responsibility](/behavioral/chain_of_responsibility.md)| Avoids coupling a sender to receiver by giving more than object a chance to handle the request | ✘ |
42
+
|[Command](/behavioral/command.md)| Bundles a command and arguments to call later | ✘ |
43
+
|[Mediator](/behavioral/mediator.md)| Connects objects and acts as a proxy | ✘ |
44
+
|[Memento](/behavioral/memento.md)| Generate an opaque token that can be used to go back to a previous state | ✘ |
45
+
|[Observer](/behavioral/observer.md)| Provide a callback for notification of events/changes to data | ✔ |
46
+
|[Registry](/behavioral/registry.md)| Keep track of all subclasses of a given class | ✘ |
47
+
|[State](/behavioral/state.md)| Encapsulates varying behavior for the same object based on its internal state | ✘ |
48
+
|[Strategy](/behavioral/strategy.md)| Enables an algorithm's behavior to be selected at runtime | ✔ |
49
+
|[Template](/behavioral/template.md)| Defines a skeleton class which defers some methods to subclasses | ✘ |
50
+
|[Visitor](/behavioral/visitor.md)| Separates an algorithm from an object on which it operates | ✘ |
51
51
52
52
## Synchronization Patterns
53
53
54
54
| Pattern | Description | Status |
55
55
|:-------:|:----------- |:------:|
56
-
|[Condition Variable](synchronization/condition_variable.md)| Provides a mechanism for threads to temporarily give up access in order to wait for some condition | ✘ |
57
-
|[Lock/Mutex](synchronization/mutex.md)| Enforces mutual exclusion limit on a resource to gain exclusive access | ✘ |
58
-
|[Monitor](synchronization/monitor.md)| Combination of mutex and condition variable patterns | ✘ |
59
-
|[Read-Write Lock](synchronization/read_write_lock.md)| Allows parallel read access, but only exclusive access on write operations to a resource | ✘ |
60
-
|[Semaphore](synchronization/semaphore.md)| Allows controlling access to a common resource | ✔ |
56
+
|[Condition Variable](/synchronization/condition_variable.md)| Provides a mechanism for threads to temporarily give up access in order to wait for some condition | ✘ |
57
+
|[Lock/Mutex](/synchronization/mutex.md)| Enforces mutual exclusion limit on a resource to gain exclusive access | ✘ |
58
+
|[Monitor](/synchronization/monitor.md)| Combination of mutex and condition variable patterns | ✘ |
59
+
|[Read-Write Lock](/synchronization/read_write_lock.md)| Allows parallel read access, but only exclusive access on write operations to a resource | ✘ |
60
+
|[Semaphore](/synchronization/semaphore.md)| Allows controlling access to a common resource | ✔ |
61
61
62
62
## Concurrency Patterns
63
63
64
64
| Pattern | Description | Status |
65
65
|:-------:|:----------- |:------:|
66
-
|[N-Barrier](concurrency/barrier.md)| Prevents a process from proceeding until all N processes reach to the barrier | ✘ |
67
-
|[Bounded Parallelism](concurrency/bounded_parallelism.md)| Completes large number of independent tasks with resource limits | ✔ |
68
-
|[Broadcast](concurrency/broadcast.md)| Transfers a message to all recipients simultaneously | ✘ |
69
-
|[Coroutines](concurrency/coroutine.md)| Subroutines that allow suspending and resuming execution at certain locations | ✘ |
70
-
|[Generators](concurrency/generator.md)| Yields a sequence of values one at a time | ✘ |
71
-
|[Reactor](concurrency/reactor.md)| Demultiplexes service requests delivered concurrently to a service handler and dispatches them syncronously to the associated request handlers | ✘ |
72
-
|[Parallelism](concurrency/parallelism.md)| Completes large number of independent tasks | ✔ |
73
-
|[Producer Consumer](concurrency/producer_consumer.md)| Separates tasks from task executions | ✘ |
74
-
|[Scheduler](concurrency/scheduler.md)| Orchestrates steps to be performed as part of a task | ✘ |
66
+
|[N-Barrier](/concurrency/barrier.md)| Prevents a process from proceeding until all N processes reach to the barrier | ✘ |
67
+
|[Bounded Parallelism](/concurrency/bounded_parallelism.md)| Completes large number of independent tasks with resource limits | ✔ |
68
+
|[Broadcast](/concurrency/broadcast.md)| Transfers a message to all recipients simultaneously | ✘ |
69
+
|[Coroutines](/concurrency/coroutine.md)| Subroutines that allow suspending and resuming execution at certain locations | ✘ |
70
+
|[Generators](/concurrency/generator.md)| Yields a sequence of values one at a time | ✘ |
71
+
|[Reactor](/concurrency/reactor.md)| Demultiplexes service requests delivered concurrently to a service handler and dispatches them syncronously to the associated request handlers | ✘ |
72
+
|[Parallelism](/concurrency/parallelism.md)| Completes large number of independent tasks | ✔ |
73
+
|[Producer Consumer](/concurrency/producer_consumer.md)| Separates tasks from task executions | ✘ |
74
+
|[Scheduler](/concurrency/scheduler.md)| Orchestrates steps to be performed as part of a task | ✘ |
75
75
76
76
## Messaging Patterns
77
77
78
78
| Pattern | Description | Status |
79
79
|:-------:|:----------- |:------:|
80
-
|[Fan-In](messaging/fan_in.md)| Funnels tasks to a work sink (e.g. server) | ✔ |
81
-
|[Fan-Out](messaging/fan_out.md)| Distributes tasks among workers (e.g. producer) | ✔ |
82
-
|[Futures & Promises](messaging/futures_promises.md)| Acts as a place-holder of a result that is initially unknown for synchronization purposes | ✘ |
83
-
|[Publish/Subscribe](messaging/publish_subscribe.md)| Passes information to a collection of recipients who subscribed to a topic | ✔ |
84
-
|[Push & Pull](messaging/push_pull.md)| Distributes messages to multiple workers, arranged in a pipeline | ✘ |
80
+
|[Fan-In](/messaging/fan_in.md)| Funnels tasks to a work sink (e.g. server) | ✔ |
81
+
|[Fan-Out](/messaging/fan_out.md)| Distributes tasks among workers (e.g. producer) | ✔ |
82
+
|[Futures & Promises](/messaging/futures_promises.md)| Acts as a place-holder of a result that is initially unknown for synchronization purposes | ✘ |
83
+
|[Publish/Subscribe](/messaging/publish_subscribe.md)| Passes information to a collection of recipients who subscribed to a topic | ✔ |
84
+
|[Push & Pull](/messaging/push_pull.md)| Distributes messages to multiple workers, arranged in a pipeline | ✘ |
85
85
86
86
## Stability Patterns
87
87
88
88
| Pattern | Description | Status |
89
89
|:-------:|:----------- |:------:|
90
-
|[Bulkheads](stability/bulkhead.md)| Enforces a principle of failure containment (i.e. prevents cascading failures) | ✘ |
91
-
|[Circuit-Breaker](stability/circuit_breaker.md)| Stops the flow of the requests when requests are likely to fail | ✔ |
92
-
|[Deadline](stability/deadline.md)| Allows clients to stop waiting for a response once the probability of response becomes low (e.g. after waiting 10 seconds for a page refresh) | ✘ |
93
-
|[Fail-Fast](stability/fail_fast.md)| Checks the availability of required resources at the start of a request and fails if the requirements are not satisfied | ✘ |
94
-
|[Handshaking](stability/handshaking.md)| Asks a component if it can take any more load, if it can't the request is declined | ✘ |
95
-
|[Steady-State](stability/steady_state.md)| For every service that accumulates a resource, some other service must recycle that resource | ✘ |
90
+
|[Bulkheads](/stability/bulkhead.md)| Enforces a principle of failure containment (i.e. prevents cascading failures) | ✘ |
91
+
|[Circuit-Breaker](/stability/circuit_breaker.md)| Stops the flow of the requests when requests are likely to fail | ✔ |
92
+
|[Deadline](/stability/deadline.md)| Allows clients to stop waiting for a response once the probability of response becomes low (e.g. after waiting 10 seconds for a page refresh) | ✘ |
93
+
|[Fail-Fast](/stability/fail_fast.md)| Checks the availability of required resources at the start of a request and fails if the requirements are not satisfied | ✘ |
94
+
|[Handshaking](/stability/handshaking.md)| Asks a component if it can take any more load, if it can't the request is declined | ✘ |
95
+
|[Steady-State](/stability/steady_state.md)| For every service that accumulates a resource, some other service must recycle that resource | ✘ |
96
96
97
97
## Profiling Patterns
98
98
99
99
| Pattern | Description | Status |
100
100
|:-------:|:----------- |:------:|
101
-
|[Timing Functions](profiling/timing.md)| Wraps a function and logs the execution | ✘ |
101
+
|[Timing Functions](/profiling/timing.md)| Wraps a function and logs the execution | ✘ |
102
102
103
103
## Idioms
104
104
105
105
| Pattern | Description | Status |
106
106
|:-------:|:----------- |:------:|
107
-
|[Functional Options](idiom/functional-options.md)| Allows creating clean APIs with sane defaults and idiomatic overrides | ✔ |
107
+
|[Functional Options](/idiom/functional-options.md)| Allows creating clean APIs with sane defaults and idiomatic overrides | ✔ |
108
108
109
109
## Anti-Patterns
110
110
111
111
| Pattern | Description | Status |
112
112
|:-------:|:----------- |:------:|
113
-
|[Cascading Failures](antipatterns/cascading_failures.md)| A failure in a system of interconnected parts in which the failure of a part causes a domino effect | ✘ |
113
+
|[Cascading Failures](/anti-patterns/cascading_failures.md)| A failure in a system of interconnected parts in which the failure of a part causes a domino effect | ✘ |
0 commit comments