forks/geef
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add typespecs to the functions

Browse Source
This commit is contained in:
Carlos Martín Nieto
2013-01-25 03:33:02 +01:00
parent 3c6b1ddaf5
commit 78e0693b8a
4 changed files with 13 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
src/geef_odb.erl
View File

@@ -3,5 +3,6 @@
-include("geef_records.hlr"). -include("geef_records.hlr").
-spec exists(odb(), string()) -> boolean().
exists(#odb{handle=Handle}, Sha) -> exists(#odb{handle=Handle}, Sha) ->
geef:odb_object_exists(Handle, Sha). geef:odb_object_exists(Handle, Sha).

4
src/geef_records.hlr
View File

@@ -2,4 +2,6 @@
-record(repo, {handle}). -record(repo, {handle}).
-record(odb, {handle}). -record(odb, {handle}).
-type repo() :: repo. -type ref() :: #ref{}.
-type repo() :: #repo{}.
-type odb() :: #odb{}.

6
src/geef_ref.erl
View File

@@ -4,11 +4,12 @@
-include("geef_records.hlr"). -include("geef_records.hlr").
-spec new(term()) -> ref().
new(Handle) -> new(Handle) ->
Type = geef:reference_type(Handle), Type = geef:reference_type(Handle),
#ref{handle=Handle, type=Type}. #ref{handle=Handle, type=Type}.
-spec lookup(term(), iolist()) -> term(). -spec lookup(repo(), iolist()) -> {ok, ref()} | {error, term()}.
lookup(#repo{handle=Handle}, Refname) -> lookup(#repo{handle=Handle}, Refname) ->
case geef:reference_lookup(Handle, Refname) of case geef:reference_lookup(Handle, Refname) of
{ok, Ref} -> {ok, Ref} ->
@@ -17,6 +18,7 @@ lookup(#repo{handle=Handle}, Refname) ->
Other Other
end. end.
-spec resolve(ref()) -> {ok, ref()} | {error, term()}.
resolve(#ref{handle=Handle}) -> resolve(#ref{handle=Handle}) ->
case geef:reference_resolve(Handle) of case geef:reference_resolve(Handle) of
{ok, Ref} -> {ok, Ref} ->
@@ -25,6 +27,6 @@ resolve(#ref{handle=Handle}) ->
Other Other
end. end.
-spec target(term()) -> binary(). -spec target(ref()) -> binary().
target(#ref{handle=Handle, type=oid}) -> target(#ref{handle=Handle, type=oid}) ->
geef:reference_target(Handle). geef:reference_target(Handle).

6
src/geef_repo.erl
View File

@@ -4,19 +4,23 @@
-include("geef_records.hlr"). -include("geef_records.hlr").
-spec path(repo()) -> binary().
path(#repo{handle=Handle}) -> path(#repo{handle=Handle}) ->
geef:repository_get_path(Handle). geef:repository_get_path(Handle).
-spec workdir(repo()) -> binary().
workdir(#repo{handle=Handle}) -> workdir(#repo{handle=Handle}) ->
geef:repository_get_workdir(Handle). geef:repository_get_workdir(Handle).
-spec is_bare(repo()) -> boolean().
is_bare(#repo{handle=Handle}) -> is_bare(#repo{handle=Handle}) ->
geef:repository_is_bare(Handle). geef:repository_is_bare(Handle).
-spec references(repo()) -> [binary()].
references(#repo{handle=Handle}) -> references(#repo{handle=Handle}) ->
geef:reference_list(Handle). geef:reference_list(Handle).
-spec open(iolist()) -> {ok, term()} | {error, term()}. -spec open(iolist()) -> {ok, repo()} | {error, term()}.
open(Path) -> open(Path) ->
case geef:repository_open(Path) of case geef:repository_open(Path) of
{ok, Handle} -> {ok, Handle} ->